Table of Contents
| Table of Contents | ||||
|---|---|---|---|---|
|
...
ℹ️ About webhooks
Webhooks enable Ondato to send you real-time notifications about changes in the status if your recourses. These are POST requests to your server that are sent as soon as the event occurs. The body of the request contains resource information.
...
🔐 Security
Ondato uses HTTPS to send these notifications as a JSON payload.
...
🛒 Ordering
Ondato deliver events asynchronically. Therefore, you might receive them out of order and handle them accordingly.
...
📫 Webhook IP
...
Addresses
All webhook requests will come from the following IPs:
...
Please make sure that these IPs are whitelisted in order to receive webhook notifications.
...
🔃 Retry Logic
Upon sending a webhook notification, we are waiting for a success response for 30 seconds. Otherwise, if your endpoint does not respond, the webhook is queued for retry. We use an exponential backoff retry policy for event delivery. The attempt to resend the notifications is according to the following schedule on a best effort basis:
...
When Event Grid can't deliver an event within a certain time period or after trying to deliver the event a certain number of times the event is dropped.
...
❔ How to start receiving webhooks?
To start receiving event notifications into your application you need to go through the following steps:
...
Please note that we also support multiple URLs for sending webhooks.
...
😶🌫️ Requirements for webhook endpoint
...
Property | Description |
|---|---|
| Webhook ID. |
| Internal ID that identifies you in Ondato system. |
| Date and time when webhook was generated. |
| Date and time when webhook was delivered. |
| Status of the webhook if it was delivered or not. Possible values are true/ false. |
| Depending on the webhpook type property, the payload always returns the same information you could obtain from the GET endpoint of the recourse. E.g. of the webhook type is |
| Type of the webook. It contains of two parts:
|
...
🪄 Events
You can configure the following events to trigger a message to registered webhooks:
...