Webhooks
Met webhooks kan een externe toepassing automatisch door MobiCRM worden verwittigd wanneer zich een gebeurtenis voordoet. MobiCRM stuurt dan een POST-request in JSON-formaat naar de URL die u hebt geregistreerd.
Authenticatie
Webhooks worden beheerd via de API van MobiCRM (/openapi/v1/webhooks) en vereisen een MobiCRM-authenticatietoken. Om vanuit de interface te testen, zie de pagina Swagger.
Een webhook is gekoppeld aan de gebruiker die hem aanmaakt. MobiCRM verstuurt enkel de elementen die zichtbaar zijn voor deze gebruiker: een contact, een oproep of een ticket waartoe hij geen toegang heeft, wordt nooit doorgestuurd.
Een abonnement aanmaken
POST /openapi/v1/webhooks
{
"hookUrl": "https://mon-application.com/webhooks/mobicrm",
"eventTypes": ["TicketCreated", "PhoneCallCreated"]
}hookUrl: URL die de gebeurtenissen zal ontvangen.eventTypes: lijst van de gewenste gebeurtenissen (zie onderstaande tabel). GebruikAllom alle gebeurtenissen te ontvangen, ook de gebeurtenissen die later worden toegevoegd.
Het antwoord (201) bevat de identificatie van de aangemaakte webhook:
{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }De abonnementen oplijsten
GET /openapi/v1/webhooks
Geeft de actieve webhooks van de geauthenticeerde gebruiker terug, gesorteerd op aanmaakdatum:
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hookUrl": "https://mon-application.com/webhooks/mobicrm",
"eventTypes": ["TicketCreated", "PhoneCallCreated"],
"creationDate": "2024-01-15T10:00:00Z"
}
]Een abonnement raadplegen
GET /openapi/v1/webhooks/{webhookId}
Geeft de webhook terug in hetzelfde formaat als hierboven, of 404 als hij niet bestaat, verwijderd werd of aan een andere gebruiker toebehoort.
Een abonnement verwijderen
DELETE /openapi/v1/webhooks/{webhookId}
Na verwijdering wordt er geen enkele gebeurtenis meer naar de betrokken URL verstuurd. Alleen de eigenaar van de webhook kan hem verwijderen: een poging op de webhook van een andere gebruiker geeft een fout 400 terug.
Beschikbare gebeurtenissen
De actuele lijst van de gebeurtenissen is beschikbaar via GET /openapi/v1/webhooks/eventtypes:
["All", "AccountCreated", "ContactCreated", "CampaignCreated", "PhoneCallCreated", "TicketCreated"]| Gebeurtenis | Geactiveerd wanneer | Inhoud van data | Verstuurd als |
|---|---|---|---|
All | Alle gebeurtenissen | Afhankelijk van de gebeurtenis | Afhankelijk van de gebeurtenis |
AccountCreated | Een account wordt aangemaakt | Account (zelfde formaat als de OpenAPI-API Account) | Het account is zichtbaar voor de eigenaar van de webhook |
ContactCreated | Een contact wordt aangemaakt | Contact (zelfde formaat als de OpenAPI-API Contact) | Het contact is zichtbaar voor de eigenaar van de webhook |
CampaignCreated | Een campagne wordt aangemaakt | Campagne | Altijd |
PhoneCallCreated | Een oproep wordt aangemaakt | Telefoonoproep (zelfde formaat als de OpenAPI-API Oproep) | Het contact van de oproep is zichtbaar voor de eigenaar van de webhook, of de oproep heeft geen contact |
TicketCreated | Een ticket wordt aangemaakt | Ticket (zelfde formaat als de OpenAPI-API Ticket) | Het ticket is toegankelijk voor de eigenaar van de webhook (toegankelijk account of contact, of ticket dat aan hem is toegewezen) |
Formaat van de ontvangen requests
Elke oproep is een POST met de header Content-Type: application/json. De body bevat het type gebeurtenis en de gegevens, met eigenschapsnamen in camelCase:
{
"eventType": "PhoneCallCreated",
"data": {
"id": "0f8fad5b-d9cb-469f-a165-70867728950e",
"contactId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"ownerId": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
"direction": "Inbound",
"startDate": "2024-01-15T10:00:00Z",
"endDate": "2024-01-15T10:02:00Z",
"duration": 120,
"ownerPhone": "0102030405",
"contactPhone": "0607080910",
"isAnswered": true,
"phoneSystem": "Aircall",
"phoneSystemExternalId": "aircall-id",
"externalId": null,
"creationDate": "2024-01-15T10:02:05Z"
}
}Goed om te weten
- Uw URL moet antwoorden met een HTTP-code
2xx. Bij een mislukking wordt de fout aan de kant van MobiCRM gelogd en wordt de verzending niet opnieuw geprobeerd: de gebeurtenis gaat verloren voor deze abonnee. - De volgorde waarin de gebeurtenissen aankomen, is niet gegarandeerd.
- Een abonnement kan niet gewijzigd worden: verwijder het en maak het opnieuw aan.
