Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

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

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

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.

Response

Created

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.

{"stackTrail":"components:schemas:conversations.v1.service.service_conversation.service_conversation_scoped_webhook:properties:configuration","oasType":"schema","type":"unknown","description":"The configuration of this webhook. Is defined based on target.","nullable":true}
conversation_sidstring nullable

The unique ID of the Conversation for this webhook.

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.

sidstring nullable

A 34 character string that uniquely identifies this resource.

targetstring nullable

The target of this webhook: webhook, studio, trigger

urlstring uri nullable

An absolute API resource URL for this webhook.