Webhooks
Les webhooks permettent à une application externe d'être prévenue automatiquement par MobiCRM lorsqu'un événement se produit. MobiCRM envoie alors une requête POST au format JSON à l'URL que vous avez enregistrée.
Authentification
La gestion des webhooks se fait via l'API MobiCRM (/openapi/v1/webhooks) et nécessite un token d'authentification MobiCRM. Pour tester depuis l'interface, voir la page Swagger.
Un webhook est rattaché à l'utilisateur qui le crée. MobiCRM n'envoie que les éléments visibles par cet utilisateur : un contact, un appel ou un ticket auquel il n'a pas accès n'est jamais transmis.
Créer un abonnement
POST /openapi/v1/webhooks
{
"hookUrl": "https://mon-application.com/webhooks/mobicrm",
"eventTypes": ["TicketCreated", "PhoneCallCreated"]
}hookUrl: URL qui recevra les événements.eventTypes: liste des événements souhaités (voir tableau ci-dessous). UtiliserAllpour recevoir tous les événements, y compris ceux ajoutés ultérieurement.
La réponse (201) contient l'identifiant du webhook créé :
{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }Lister les abonnements
GET /openapi/v1/webhooks
Retourne les webhooks actifs de l'utilisateur authentifié, triés par date de création :
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hookUrl": "https://mon-application.com/webhooks/mobicrm",
"eventTypes": ["TicketCreated", "PhoneCallCreated"],
"creationDate": "2024-01-15T10:00:00Z"
}
]Consulter un abonnement
GET /openapi/v1/webhooks/{webhookId}
Retourne le webhook au même format que ci-dessus, ou 404 s'il n'existe pas, a été supprimé ou appartient à un autre utilisateur.
Supprimer un abonnement
DELETE /openapi/v1/webhooks/{webhookId}
Après suppression, plus aucun événement n'est envoyé à l'URL concernée. Seul le propriétaire du webhook peut le supprimer : une tentative sur le webhook d'un autre utilisateur renvoie une erreur 400.
Événements disponibles
La liste à jour des événements est disponible via GET /openapi/v1/webhooks/eventtypes :
["All", "AccountCreated", "ContactCreated", "CampaignCreated", "PhoneCallCreated", "TicketCreated"]| Événement | Déclenché quand | Contenu de data | Envoyé si |
|---|---|---|---|
All | Tous les événements | Selon l'événement | Selon l'événement |
AccountCreated | Un compte est créé | Compte (même format que l'API OpenAPI Compte) | Le compte est visible par le propriétaire du webhook |
ContactCreated | Un contact est créé | Contact (même format que l'API OpenAPI Contact) | Le contact est visible par le propriétaire du webhook |
CampaignCreated | Une campagne est créée | Campagne | Toujours |
PhoneCallCreated | Un appel est créé | Appel téléphonique (même format que l'API OpenAPI Appel) | Le contact de l'appel est visible par le propriétaire du webhook, ou l'appel n'a pas de contact |
TicketCreated | Un ticket est créé | Ticket (même format que l'API OpenAPI Ticket) | Le ticket est accessible au propriétaire du webhook (compte ou contact accessible, ou ticket qui lui est assigné) |
Format des requêtes reçues
Chaque appel est un POST avec l'en-tête Content-Type: application/json. Le corps contient le type d'événement et les données, avec des noms de propriétés en 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"
}
}Bon à savoir
- Votre URL doit répondre avec un code HTTP
2xx. En cas d'échec, l'erreur est consignée côté MobiCRM et l'envoi n'est pas retenté : l'événement est perdu pour cet abonné. - L'ordre d'arrivée des événements n'est pas garanti.
- Il n'est pas possible de modifier un abonnement : supprimez-le puis recréez-le.
