TWtwilio
ConversationsV1Webhook

Create a new webhook scoped to the conversation in a specific service

Changed on

Create a new webhook scoped to the conversation in a specific service

post/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks

Request

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service the Participant resource is associated with.

ConversationSidstring required

The unique ID of the Conversation for this webhook.

Request body application/x-www-form-urlencoded

Target'webhook' | 'trigger' | 'studio' required

The target of this webhook: webhook, studio, trigger

Configuration.Urlstring

The absolute url the webhook request should be sent to.

Configuration.Method'get' | 'post'
Configuration.Filtersstring[]

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

Configuration.Triggersstring[]

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

Configuration.FlowSidstring

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

Configuration.ReplayAfterinteger

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

Response

Created

sidstring nullable

A 34 character string that uniquely identifies this resource.

account_sidstring nullable

The unique ID of the Account responsible for this conversation.

chat_service_sidstring nullable

The SID of the Conversation Service the Participant resource is associated with.

conversation_sidstring nullable

The unique ID of the Conversation for this webhook.

targetstring nullable

The target of this webhook: webhook, studio, trigger

urlstring uri nullable

An absolute API resource URL for this webhook.

configurationunknown
date_createdstring date-time nullable

The date that this resource was created.

date_updatedstring date-time nullable

The date that this resource was last updated.

Changes

  • v192d1169c37c2Revision changes
    • breaking

      removed the enum value GET of the request property

    • breaking

      removed the enum value POST of the request property

    • breaking

      the response's property type changed from object to no type for status

    • info

      added the new get enum value to the request property

    • info

      added the new post enum value to the request property

  • v1b4d0e634cd69Revision changes
    • breaking

      the response's property type changed from no type to object for status