Webhooks invocation
Webhook call
POST
https://your-webhook-endpoint
Once the webhooks have been set up on the client page, they will be invoked for the selected event (e.g., DELIVERY_STATUS_CHANGED
) by sending a POST
request to the specified URL with a payload relevant to the event type.
Based on BeeFast's internal implementation, webhook calls are not guaranteed to be in order, but one-time delivery is guaranteed. For example, in rare cases, for DELIVERY_STATUS_CHANGED
, the DELIVERED status might be sent before IN_DELIVERY_AT_DROPOFF, or the same status might be sent multiple times.
Response requirements
Response sent from your endpoint must be completed within
10s
.Response status code must be
200
If the maximum timeout is exceeded, the webhook invocation is retried.
Retry mechanism
Failed invocations will be retried:
For a duration of 24 hours
After exponential backoff delay with 10s min backoff and 600s max backoff
Common payload structure
{
"id": "15385922081235562",
"requestTs": 1752141381,
"event": "DELIVERY_STATUS_CHANGED",
"data": {...} //event specific data
}
id
string
The request's id
requestTs
number
The timestamp, in seconds, when the request was made
event
The event type
data
An object with the data relevant to the event type
Last updated