...
| Code Block |
|---|
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Naam van deze webhook",
"webhookDefinitionName": "OrderStatusChanged", // verwijzing naar bestaande webhookdefinition
"httpConfiguration": { // configuratie waarmee bericht naar extern systeem wordt gestuurd
"method": "POST", /
"url": "https://some.url",
"username": "user", // username en password worden gebruikt voor Basic authenticatie
"password": "pwd",
"httpHeaders": [ // eventueel aanvullende headers
{
"key": "string",
"value": "string"
}
]
},
"filter": {
"filterTemplate": "string" // zie uitleg verderop in dit artikel
},
"includedResourceNames": [ // zie uitleg verderop in dit artikel
"Order",
"Customer",
"Company",
"IncidentLocation",
"InterimLocations",
"DestinationLocation",
"ImOrder",
"Vehicle",
"Jobs",
"JobBillings"
],
"isActive": true // statucstatus van de webhook.
} |
Verwijderen van een webhook
...
Voor een webhook die niet actief is, worden de events in Assistance Online genegeerd en wordt er geen bericht verstuurd naar een extern systeem.
Opvragen logging
met Met gebruik van GET /webhooks/:id/invocations en GET /webhooks/:id/invocations/:invocationId kan de logging worden opgevraagd .
...
Instellen Filter
BIj het configureren van een webhook kan een filter worden ingesteld om meer specifiek te kunnen bepalen wanneer er informatie naar een extern systeem wordt gestuurd.
...
Dit template levert true bij het voorbeeld bericht true en wordt het bericht op. Het bericht zal dus worden verzonden.
Bij andere waarden voor newStatus wordt false geleverd en wordt zal het bericht niet verzonden worden.
Bij het afhandelen van een event in Assistance Online door een webhook, worden eerst alle resources opgehaald, waarna het filter wordt toegepast.
Instellen IncludedResourceNames
Bij het configureren van een webhook kan je aangeven welke resources er met het bericht meegestuurd moeten worden. Als je dit veld leeg laat, zullen er geen resources meegestuurd worden.