Skip to main content

Configure delivery-status webhook

POST 
/api/partner-gateway/v1/webhooks/delivery-status

Registers an HTTPS callback URL to receive real-time delivery-status notifications. Once configured, the platform will send an HTTP POST request to your callback URL every time a delivery-status event occurs for messages sent through your account. Events include statuses such as delivered, read, failed, and other channel-specific states across SMS, RCS, and WhatsApp. The callback URL must use HTTPS. The payload is a JSON object containing the message ID, channel, status, timestamp, and any error details. Your server must respond with a 2xx status code within a reasonable timeout to acknowledge receipt. If your endpoint is unreachable or returns an error, the platform may retry the notification a limited number of times before giving up. Only one webhook URL can be active per account. If a webhook is already configured, this endpoint returns 409 Conflict. In that case, use PUT /webhooks/delivery-status to update the existing URL, or DELETE /webhooks/delivery-status to remove it first. Returns 400 if the request body is invalid (e.g. missing or malformed callbackUrl). Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.

Request​

Responses​

Webhook configured successfully

Last updated on