Let op! Voordat je verder kunt heb je een API key nodig. Deze kun je via de chat bij ons opvragen.

Authenticatie

Met een request header
Stel de X-Authorization request header als volgt in voor ieder request:
Basic 2dd0da7ed23d170efecab01524b67dad409e57a200130a5123817021191a1

Met een query parameter
Voeg de key parameter toe als volgt toe aan je url:
?key=2dd0da7ed23d170efecab01524b67dad409e57a200130a5123817021191a1 

Request format

De API kan alleen gebruikt worden met het JSON format.

Error response

{
  "data": {
  },
  "page": {
    "status": "error",
    "status_code": 422,
    "message": "Request validation failed",
    "errors": {
      "locale": "This field is incorrect"
    }
  }
}

Ondersteunde velden in MICE Operations

  • datetime_start
    Startdatum en -tijd van het evenement.
  • datetime_end
    Einddatum en -tijd van het evenement.
  • name
    De naam van het evenement. We raden aan om altijd een evenementnaam op te geven. Eventueel samengesteld uit meerdere velden uit het formulier. Zie voorbeeld.
  • group_name
    De groepsnaam.
  • noticeboard_name
    Een specifieke naam voor op het notitiebord.
  • guests
    Het aantal personen. Dit moet een nummer zijn.
  • locale
    De taalvoorkeur van de opdrachtgever. (ISO code, bijv. nl_NL of en_US)
  • reference
    Een referentienummer of code
  • company
    Bedrijfsnaam van de opdrachtgever.
  • address_line_1
    Straatnaam en huisnummer van de opdrachtgever.
  • address_line_2
    Extra adresregel voor adres van de opdrachtgever.
  • postalcode
    Postcode van de opdrachtgever.
  • city
    Plaatsnaam van de opdrachtgever.
  • country
    Land van de opdrachtgever.
  • contact_first_name
    Voornaam van de opdrachtgever.
  • contact_last_name
    Achternaam van de opdrachtgever.
  • contact_phone
    Telefoonnumer van de opdrachtgever.
  • contact_email
    E-mailadres van de opdrachtgever.
  • message
    Interne notities bij de boeking.
  • booking_message
    Extra opmerkingen van de opdrachtgever.
  • location_id
    In MICE Operations kun je onder beheer het ID-nummer opzoeken van een bepaalde locatie. Dit nummer kun je doorgeven om het evenement direct te koppelen aan de locatie of zaal.
  • event_type_id
    In MICE Operations kun je onder beheer het ID-nummer opzoeken van een evenementtype (bijv. Vergadering, Workshop, etc). Dit nummer kun je doorgeven om het evenement direct te koppelen aan een bepaald soort evenement.
  • source
    In het source-veld kun je een referentie opgeven naar het formulier. Zo kun je later in rapportages terugzoeken hoe verschillende formulieren en aanvraagmodules presteren.

Evenement aanmaken

POST /api/v1/webhooks/events

Voorbeeld

{
  name: "Test event",
  group_name: "MICE Operations",
  locale: "en_US",
  guests: 15,
  contact_first_name: "John",
  contact_last_name: "Doe",
  contact_email: "johndoe@miceoperations.com",
  source: "Webhook documentation",
  extra_fields: [
    {
      question: "Any remarks?",
      answer: "I would like to have sweet potatoes"
    }
  ]
}


Responses

  • 201 – Event was successfully created
  • 401 – Authorization failed (incorrect or disabled key)
  • 422 – Data validation failed

Heeft u het antwoord gevonden?