Service-Scoped Conversation-Scoped Webhook Resource
Service-Scoped Conversation-Scoped Webhooks provide a way to attach a unique monitor, bot, or other integration to each service-scoped Conversation within a non-default Conversation Service.
Each individual service-scoped Conversation can have as many as five such webhooks, as needed for your use case.
Please see the API Reference for the Conversation-Scoped Webhook resource for creating and managing Conversation-Scoped Webhooks within the default Conversation Service.
API Base URL
All URLs in the reference documentation use the following base URL:
https://conversations.twilio.com/v1
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:
GET /v1/Services/ISxx/Conversations/CHxx/Messages
Service-Scoped Conversation-Scoped Webhook Properties
| Resource Properties in REST API format | |
|---|---|
sid
|
A 34 character string that uniquely identifies this resource. |
account_sid
|
The unique ID of the Account responsible for this conversation. |
chat_service_sid
|
The SID of the Conversation Service the Participant resource is associated with. |
conversation_sid
|
The unique ID of the Conversation for this webhook. |
target
|
The target of this webhook: |
url
|
An absolute API resource URL for this webhook. |
configuration
|
The configuration of this webhook. Is defined based on target. |
date_created
|
The date that this resource was created. |
date_updated
|
The date that this resource was last updated. |
Create a Service-Scoped Conversation-Scoped Webhook resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Participant resource is associated with. |
conversation_sid
Path
|
The unique ID of the Conversation for this webhook. |
target
Required
|
The target of this webhook: |
configuration.url
Optional
|
The absolute url the webhook request should be sent to. |
configuration.method
Optional
|
The HTTP method to be used when sending a webhook request. |
configuration.filters
Optional
|
The list of events, firing webhook event for this Conversation. |
configuration.triggers
Optional
|
The list of keywords, firing webhook event for this Conversation. |
configuration.flow_sid
Optional
|
The studio flow SID, where the webhook should be sent to. |
configuration.replay_after
Optional
|
The message index for which and it's successors the webhook will be replayed. Not set by default |
Example 1
Fetch a Service-Scoped Conversation-Scoped Webhook resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Participant resource is associated with. |
conversation_sid
Path
|
The unique ID of the Conversation for this webhook. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
Example 1
Read multiple Service-Scoped Conversation-Scoped Webhook resources
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Participant resource is associated with. |
conversation_sid
Path
|
The unique ID of the Conversation for this webhook. |
Example 1
Update a Service-Scoped Conversation-Scoped Webhook resources
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Participant resource is associated with. |
conversation_sid
Path
|
The unique ID of the Conversation for this webhook. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
configuration.url
Optional
|
The absolute url the webhook request should be sent to. |
configuration.method
Optional
|
The HTTP method to be used when sending a webhook request. |
configuration.filters
Optional
|
The list of events, firing webhook event for this Conversation. |
configuration.triggers
Optional
|
The list of keywords, firing webhook event for this Conversation. |
configuration.flow_sid
Optional
|
The studio flow SID, where the webhook should be sent to. |
Example 1
Delete a Service-Scoped, Conversation-Scoped Webhook resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Participant resource is associated with. |
conversation_sid
Path
|
The unique ID of the Conversation for this webhook. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
