v1

latestOpenAPI 3.0.0raw.githubusercontent.com2025-10-15121927.4 KB

Configuration

Update the webhook URL for receiving message events

Configure the webhook URL that will receive all message events. Once configured, your endpoint will receive POST requests with the following event types:

message.received - When you receive an inbound message
message.sent - When your outbound message is sent to the carrier
message.delivered - When your outbound message is delivered to the recipient
message.failed - When your outbound message fails to deliver
message.read - When your outbound message is read by the recipient (iMessage only, recipient must have read receipts enabled)

See the webhook event schemas for detailed payload formats.

put/v1/api/config/webhook

Request body

webhook_urlstring uri required

Example request

{
  "webhook_url": "https://example.com/mywebhook"
}

Response

Webhook URL updated.

statusstring

messagestring

Example response

{
  "status": "success",
  "message": "Webhook URL updated successfully"
}