Twilio Proxy can call a webhook in your system to notify you of various events. To enable webhooks, configure an optional callback URL on your Proxy Service using either the REST API or the Console.
| Name | Description |
|---|---|
| CallbackUrl | These webhooks are fired for each new interaction and are informational only. |
| InterceptCallbackUrl | Fires on each interaction. If responded to with a 403 to this webhook we will abort/block the interaction. Any other status or timeout, the interaction continues. |
| OutOfSessionCallbackUrl | A URL to send webhooks to when an action (inbound call or SMS) occurs where there is no session or a closed session. If your server (or a Twilio function) responds with valid TwiML, this will be processed. This means it is possible to e.g. play a message for a call, send an automated text message response, or redirect a call to another number. |
All webhook parameters are submitted as form parameters (application/x-www-form-urlencoded). Each webhook above will pass you specific parameters as shown below with their example values.
| Name | Example Value |
|---|---|
| inboundParticipantSid | KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundResourceSid | CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundResourceStatus | completed |
| inboundResourceType | call |
| inboundResourceUrl | https://api.twilio.com/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json |
| interactionAccountSid | ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionData | |
| interactionDateCreated | 2018-03-13T22:42:54Z |
| interactionDateUpdated | 2018-03-13T22:42:56Z |
| interactionServiceSid | KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionSessionSid | KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionSid | KIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionType | Voice |
| outboundParticipantSid | KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundResourceSid | CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundResourceStatus | initiated |
| outboundResourceType | call |
| outboundResourceUrl | https://api.twilio.com/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json |
| Name | Example Value |
|---|---|
| inboundParticipantSid | KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundResourceSid | CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundResourceStatus | completed |
| inboundResourceType | call |
| inboundResourceUrl | https://api.twilio.com/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Calls/CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json |
| interactionAccountSid | ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionData | |
| interactionDateCreated | 2018-03-13T22:42:54Z |
| interactionDateUpdated | 2018-03-13T22:42:54Z |
| interactionServiceSid | KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionSessionSid | KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionSid | KIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| interactionType | Voice |
| Name | Example Value |
|---|---|
| AccountSid | ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| AddOns | {"status":"successful","message":null,"code":null,"results":{}} |
| ApiVersion | 2010-04-01 |
| Called | +1415XXXXXXX |
| CalledCity | OAKLAND |
| CalledCountry | US |
| CalledState | CA |
| CalledZip | 94612 |
| Caller | +1951XXXXXXX |
| CallerCity | CORONA |
| CallerCountry | US |
| CallerState | CA |
| CallerZip | 92879 |
| CallSid | CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| CallStatus | ringing |
| Direction | inbound |
| From | +1951XXXXXXX |
| FromCity | CORONA |
| FromCountry | US |
| FromState | CA |
| FromZip | 92879 |
| inboundParticipantAccountSid | ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundParticipantDateCreated | 2018-03-14T06:22:05Z |
| inboundParticipantDateUpdated | 2018-03-14T06:22:05Z |
| inboundParticipantFriendlyName | user_cjeqp7cxv00018dd5ho0n2792 |
| inboundParticipantIdentifier | +1951XXXXXXX |
| inboundParticipantProxyIdentifier | +1415XXXXXXX |
| inboundParticipantProxyIdentifierSid | PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundParticipantServiceSid | KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundParticipantSessionSid | KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| inboundParticipantSid | KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundParticipantAccountSid | AC4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundParticipantDateCreated | 2018-03-14T06:22:06Z |
| outboundParticipantDateUpdated | 2018-03-14T06:22:06Z |
| outboundParticipantFriendlyName | user_cjeqp7d7w00028dd5d7bus6vj |
| outboundParticipantIdentifier | +1707XXXXXXX |
| outboundParticipantProxyIdentifier | +1707XXXXXXX |
| outboundParticipantProxyIdentifierSid | PNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundParticipantServiceSid | KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundParticipantSessionSid | KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| outboundParticipantSid | KPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| sessionAccountSid | ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| sessionClosedReason | api |
| sessionDateCreated | 2018-03-14T06:22:05Z |
| sessionDateEnded | 2018-03-14T06:22:06Z |
| sessionDateUpdated | 2018-03-14T06:22:06Z |
| sessionMode | voice-only |
| sessionServiceSid | KSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| sessionSid | KCXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| sessionStatus | closed |
| sessionUniqueName | session_cjeqp7cot00008dd5v4rbowgp |
| To | +1415XXXXXXX |
| ToCity | OAKLAND |
| ToCountry | US |
| ToState | CA |
| ToZip | 94612 |