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.
All URLs in the reference documentation use the following base URL:
_10https://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:
_10GET /v1/Services/ISxx/Conversations/CHxx/Messages
sid
type: SID<WH>A 34 character string that uniquely identifies this resource.
^WH[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The unique ID of the Account responsible for this conversation.
^AC[0-9a-fA-F]{32}$
34
34
chat_service_sid
type: SID<IS>The SID of the Conversation Service the Participant resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
conversation_sid
type: SID<CH>The unique ID of the Conversation for this webhook.
^CH[0-9a-fA-F]{32}$
34
34
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Participant resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
Target
type: enum<string>RequiredThe target of this webhook: webhook
, studio
, trigger
webhook
trigger
studio
Configuration.Method
type: enum<string>The HTTP method to be used when sending a webhook request.
GET
POST
Configuration.Filters
type: array[string]The list of events, firing webhook event for this Conversation.
Configuration.Triggers
type: array[string]The list of keywords, firing webhook event for this Conversation.
Configuration.FlowSid
type: SID<FW>The studio flow SID, where the webhook should be sent to.
^FW[0-9a-fA-F]{32}$
34
34
Configuration.ReplayAfter
type: integerThe message index for which and it's successors the webhook will be replayed. Not set by default
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Participant resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
Sid
type: SID<WH>A 34 character string that uniquely identifies this resource.
^WH[0-9a-fA-F]{32}$
34
34
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Participant resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Participant resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
Sid
type: SID<WH>A 34 character string that uniquely identifies this resource.
^WH[0-9a-fA-F]{32}$
34
34
Configuration.Method
type: enum<string>The HTTP method to be used when sending a webhook request.
GET
POST
Configuration.Filters
type: array[string]The list of events, firing webhook event for this Conversation.
Configuration.Triggers
type: array[string]The list of keywords, firing webhook event for this Conversation.
Configuration.FlowSid
type: SID<FW>The studio flow SID, where the webhook should be sent to.
^FW[0-9a-fA-F]{32}$
34
34
DELETE https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Participant resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
Sid
type: SID<WH>A 34 character string that uniquely identifies this resource.
^WH[0-9a-fA-F]{32}$
34
34