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 Name | Description |
---|---|
Message.Received | Fired when an incoming message is received. |
Message.DeliveryReceiptReceived | Fired when a delivery receipt is received. |
Parameters
Common Parameters
The following parameters are present in every request.
Parameter | Type | Description |
---|---|---|
Action | string | Value will be: Webhook |
Event | string | The name of the event as per the event table. |
Account.Sid | string | The secure identifier of the applicable account. |
Property.Sid | string | The secure identifier of the applicable property. |
Message Parameters
The following parameters are present in every incoming SMS or delivery receipt.
Parameter | Type | Description |
---|---|---|
Message.Sid | string | The secure identifier of the message. |
Message.From | string | The sender ID of the sender of the message. This may be alphanumeric or in E164 international format with a + prefix. |
Message.To | string | The recipient of the message. This will be in E164 international format with a + prefix. |
Message.Text | string | The 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. |