Webhooks
Mit Webhooks kann eine externe Anwendung von MobiCRM automatisch benachrichtigt werden, wenn ein Ereignis eintritt. MobiCRM sendet dann eine POST-Anfrage im JSON-Format an die von Ihnen registrierte URL.
Authentifizierung
Webhooks werden über die MobiCRM-API (/openapi/v1/webhooks) verwaltet; dafür ist ein MobiCRM-Authentifizierungstoken erforderlich. Informationen zum Testen über die Oberfläche finden Sie auf der Seite Swagger.
Ein Webhook ist dem Benutzer zugeordnet, der ihn erstellt. MobiCRM sendet nur die Elemente, die für diesen Benutzer sichtbar sind: Ein Kontakt, ein Anruf oder ein Ticket, auf den bzw. das er keinen Zugriff hat, wird niemals übermittelt.
Abonnement erstellen
POST /openapi/v1/webhooks
{
"hookUrl": "https://mon-application.com/webhooks/mobicrm",
"eventTypes": ["TicketCreated", "PhoneCallCreated"]
}hookUrl: URL, die die Ereignisse empfängt.eventTypes: Liste der gewünschten Ereignisse (siehe Tabelle unten). Verwenden SieAll, um alle Ereignisse zu empfangen, einschließlich später hinzugefügter.
Die Antwort (201) enthält die Kennung des erstellten Webhooks:
{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }Abonnements auflisten
GET /openapi/v1/webhooks
Gibt die aktiven Webhooks des authentifizierten Benutzers zurück, sortiert nach Erstellungsdatum:
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hookUrl": "https://mon-application.com/webhooks/mobicrm",
"eventTypes": ["TicketCreated", "PhoneCallCreated"],
"creationDate": "2024-01-15T10:00:00Z"
}
]Abonnement abrufen
GET /openapi/v1/webhooks/{webhookId}
Gibt den Webhook im gleichen Format wie oben zurück, oder 404, wenn er nicht existiert, gelöscht wurde oder einem anderen Benutzer gehört.
Abonnement löschen
DELETE /openapi/v1/webhooks/{webhookId}
Nach dem Löschen werden keine Ereignisse mehr an die betreffende URL gesendet. Nur der Eigentümer des Webhooks kann ihn löschen: Ein Versuch, den Webhook eines anderen Benutzers zu löschen, gibt einen Fehler 400 zurück.
Verfügbare Ereignisse
Die aktuelle Liste der Ereignisse ist über GET /openapi/v1/webhooks/eventtypes verfügbar:
["All", "AccountCreated", "ContactCreated", "CampaignCreated", "PhoneCallCreated", "TicketCreated"]| Ereignis | Ausgelöst, wenn | Inhalt von data | Gesendet, wenn |
|---|---|---|---|
All | Alle Ereignisse | Je nach Ereignis | Je nach Ereignis |
AccountCreated | Ein Konto erstellt wird | Konto (gleiches Format wie die OpenAPI-API Konto) | Das Konto für den Eigentümer des Webhooks sichtbar ist |
ContactCreated | Ein Kontakt erstellt wird | Kontakt (gleiches Format wie die OpenAPI-API Kontakt) | Der Kontakt für den Eigentümer des Webhooks sichtbar ist |
CampaignCreated | Eine Kampagne erstellt wird | Kampagne | Immer |
PhoneCallCreated | Ein Anruf erstellt wird | Telefonanruf (gleiches Format wie die OpenAPI-API Anruf) | Der Kontakt des Anrufs für den Eigentümer des Webhooks sichtbar ist oder der Anruf keinen Kontakt hat |
TicketCreated | Ein Ticket erstellt wird | Ticket (gleiches Format wie die OpenAPI-API Ticket) | Das Ticket für den Eigentümer des Webhooks zugänglich ist (Konto oder Kontakt zugänglich oder Ticket ihm zugewiesen) |
Format der empfangenen Anfragen
Jeder Aufruf ist ein POST mit dem Header Content-Type: application/json. Der Body enthält den Ereignistyp und die Daten, mit Eigenschaftsnamen 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"
}
}Gut zu wissen
- Ihre URL muss mit einem HTTP-Code
2xxantworten. Bei einem Fehler wird dieser auf MobiCRM-Seite protokolliert und der Versand wird nicht wiederholt: Das Ereignis geht für diesen Abonnenten verloren. - Die Reihenfolge, in der die Ereignisse eintreffen, ist nicht garantiert.
- Ein Abonnement kann nicht geändert werden: Löschen Sie es und erstellen Sie es anschließend neu.
