Messaging Webhooks allow you to receive HTTP callbacks at user-defined URIs when certain messaging events occur.

You can receive webhooks using GET or POST.

Events

The following events are supported.

Event NameDescription
Message.ReceivedFired when an incoming message is received.
Message.DeliveryReceiptReceivedFired when a delivery receipt is received.

Parameters

Common Parameters

The following parameters are present in every request.

ParameterTypeDescription
ActionstringValue will be: Webhook
EventstringThe name of the event as per the event table.
Account.SidstringThe secure identifier of the applicable account.
Property.SidstringThe secure identifier of the applicable property.

Message Parameters

The following parameters are present in every incoming SMS or delivery receipt.

ParameterTypeDescription
Message.SidstringThe secure identifier of the message.
Message.FromstringThe sender ID of the sender of the message. This may be alphanumeric or in E164 international format with a + prefix.
Message.TostringThe recipient of the message. This will be in E164 international format with a + prefix.
Message.TextstringThe message body of the message that this request relates to. In the case of an incoming message, this is the incoming message text. In the case of a deliver receipt, this is the text of the original message that was sent.