Menu

Expand
Rate this page:

Conversation Scoped Webhook Resource

Conversation Scoped Webhooks provide a way to attach a unique monitor, bot, or other integration to each conversation.

Each individual Conversation can have as many as five such webhooks, as needed for your use case. This is your go-to tool for adding integrations with third-party bots or Twilio Studio.

For bot integrations, in particular, pay specific attention to the ReplayAfter parameter to ensure that you don't miss any messages that arrive while you're configuring the integration.

Only post-event webhooks are supported by the Conversation-Scoped Webhooks.

API Base URL

All URLs in the reference documentation use the following base URL:

https://conversations.twilio.com/v1

Using the shortened base URL

Using the REST API, you can interact with Conversation Scoped Webhook resources in the default Conversation Service instance via a "shortened" URL that does not include the Conversation Service instance SID ("ISXXX..."). If you are only using one Conversation Service (the default), you do not need to include the Conversation Service SID in your URL, e.g.

GET /v1/Conversations/CHxxx/Webhooks

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/Webhooks

ConversationScopedWebhook properties

Resource Properties in REST API format
sid
sid<WH> Not PII

A 34 character string that uniquely identifies this resource.

account_sid
sid<AC> Not PII

The unique ID of the Account responsible for this conversation.

conversation_sid
sid<CH> Not PII

The unique ID of the Conversation for this webhook.

target
string Not PII

The target of this webhook: webhook, studio, trigger

url
url Not PII

An absolute API resource URL for this webhook.

configuration
object Not PII

The configuration of this webhook. Is defined based on target.

date_created
date_time<iso8601> Not PII

The date that this resource was created.

date_updated
date_time<iso8601> Not PII

The date that this resource was last updated.

Create a ConversationScopedWebhook resource

post
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks
Parameters
Parameters in REST API format
conversation_sid
Path
post sid_like<CH> Not PII

The unique ID of the Conversation for this webhook.

target
Required
post ienum:target Not PII

The target of this webhook: webhook, studio, trigger

configuration.url
Optional
post string Not PII

The absolute url the webhook request should be sent to.

configuration.method
Optional
post ienum:method Not PII

The HTTP method to be used when sending a webhook request.

configuration.filters
Optional
post string[] Not PII

The list of events, firing webhook event for this Conversation.

configuration.triggers
Optional
post string[] Not PII

The list of keywords, firing webhook event for this Conversation.

configuration.flow_sid
Optional
post sid<FW> Not PII

The studio flow SID, where the webhook should be sent to.

configuration.replay_after
Optional
post integer Not PII

The message index for which and it's successors the webhook will be replayed. Not set by default

Example 1
Loading Code Sample...
        
        

        CREATE: Attach a new Conversation Scoped Webhook

        Fetch a ConversationScopedWebhook resource

        get
        https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks/{Sid}
        Parameters
        Parameters in REST API format
        conversation_sid
        Path
        get sid_like<CH> Not PII

        The unique ID of the Conversation for this webhook.

        sid
        Path
        get sid<WH> Not PII

        A 34 character string that uniquely identifies this resource.

        Example 1
        Loading Code Sample...
              
              

              FETCH: Retrieve a Conversation Scoped Webhook

              Read multiple ConversationScopedWebhook resources

              get
              https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks
              Parameters
              Parameters in REST API format
              conversation_sid
              Path
              get sid_like<CH> Not PII

              The unique ID of the Conversation for this webhook.

              Example 1
              Loading Code Sample...
                    
                    

                    READ: List all Conversation Scoped Webhooks

                    Update a ConversationScopedWebhook resource

                    post
                    https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks/{Sid}
                    Parameters
                    Parameters in REST API format
                    conversation_sid
                    Path
                    post sid_like<CH> Not PII

                    The unique ID of the Conversation for this webhook.

                    sid
                    Path
                    post sid<WH> Not PII

                    A 34 character string that uniquely identifies this resource.

                    configuration.url
                    Optional
                    post string Not PII

                    The absolute url the webhook request should be sent to.

                    configuration.method
                    Optional
                    post ienum:method Not PII

                    The HTTP method to be used when sending a webhook request.

                    configuration.filters
                    Optional
                    post string[] Not PII

                    The list of events, firing webhook event for this Conversation.

                    configuration.triggers
                    Optional
                    post string[] Not PII

                    The list of keywords, firing webhook event for this Conversation.

                    configuration.flow_sid
                    Optional
                    post sid<FW> Not PII

                    The studio flow SID, where the webhook should be sent to.

                    Example 1
                    Loading Code Sample...
                          
                          

                          UPDATE: Configure a Conversation Scoped Webhook

                          Delete a ConversationScopedWebhook resource

                          delete
                          https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks/{Sid}
                          Parameters
                          Parameters in REST API format
                          conversation_sid
                          Path
                          delete sid_like<CH> Not PII

                          The unique ID of the Conversation for this webhook.

                          sid
                          Path
                          delete sid<WH> Not PII

                          A 34 character string that uniquely identifies this resource.

                          Example 1
                          Loading Code Sample...
                                
                                

                                DELETE: Detach a Conversation Scoped Webhook

                                Rate this page:

                                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.

                                Loading Code Sample...
                                      
                                      
                                      

                                      Thank you for your feedback!

                                      Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                      Sending your feedback...
                                      🎉 Thank you for your feedback!
                                      Something went wrong. Please try again.

                                      Thanks for your feedback!

                                      thanks-feedback-gif