Webhooks

Configure an HTTPS callback URL to receive real-time delivery-status notifications.

📄️Update delivery-status webhook

Replaces the callback URL of the existing delivery-status webhook with a new URL. Use this when your server endpoint changes and you want to redirect notifications without any downtime. The update takes effect immediately: subsequent delivery-status events will be sent to the new URL. The new callback URL must use HTTPS. This endpoint does not create a webhook if none exists. If no webhook is currently configured, a 404 is returned; use POST /webhooks/delivery-status to create one 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.

📄️Revoke delivery-status webhook

Permanently removes the configured delivery-status webhook. After deletion, no further delivery-status notifications will be sent to the previously configured URL. The change takes effect immediately. If you need to receive notifications again in the future, you must create a new webhook using POST /webhooks/delivery-status. Any in-flight notification requests that were already dispatched before the deletion may still arrive at the old URL; this is expected and does not indicate an error. Returns 204 on success with no response body. Returns 404 if no webhook is currently configured. Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.

📄️Get delivery-status webhook

Returns the HTTPS callback URL currently configured to receive real-time delivery-status notifications for your account. The platform sends an HTTP POST to this URL every time a delivery-status event occurs for any message sent through your account, across all channels (SMS, RCS, WhatsApp). The same callback URL is shared across all channels; you do not configure separate URLs per channel. Use this endpoint to verify your current webhook configuration before updating or troubleshooting delivery-status callbacks. Returns 404 if no webhook has been configured yet. To set one up, use POST /webhooks/delivery-status. Returns 401 if the API key is missing or invalid. Returns 500 if an internal error occurs.

📄️Configure delivery-status webhook

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.