🎣 Webhooks
Webhooks allow your application to receive notification of events as they happen in Turaco's systems. Webhooks also allow your application to receive responses to requests submitted using asynchronous API methods.
This documentation details how to configure and use Turaco webhooks in your application.
Format:
All the webhook payloads from Turaco follow the same general structure. They will contain the event type, the type of entity contained in the payload, and the webhook payload containing the entity involved in the event.
{
"entity": "CLAIM",
"action": "CREATE",
"payload": {
...claim entity body
}
}| Parameter | Description |
|---|---|
entity | This can be either CLAIM, POLICY or CUSTOMER |
action | One of these actions: CREATE, UPDATE, DELETE, APPROVE, REJECT, PROCESSING, PAYMENT or CLOSE |
payload | Contains either the Customer, Claim or Policy response entities as described in the API documentation |
Configuration
The webhook details can be configured via the Update Webhook Details API, or by contacting our team using the contact details provided elsewhere in this documentation. The saved configurations can also be queried through the Get Webhook Details API.
🗝️ Security
The webhooks configuration allows the partner to configure authorization details for their webhook API. The Webhook API currently supposed three configurations: NONE, BEARER and BASIC. Both BEARER and BASIC require configuring the token to be used in the Authorization header.
Authorization: Bearer configured-partner-token