Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Fetch a specific service webhook configuration.

get/v1/Services/{ChatServiceSid}/Configuration/Webhooks

Path parameters

ChatServiceSidstring required

The unique ID of the Conversation Service this conversation belongs to.

Response

OK

account_sidstring nullable

The unique ID of the Account responsible for this service.

chat_service_sidstring nullable

The unique ID of the Conversation Service this conversation belongs to.

filtersstring[] nullable

The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are onParticipantAdd, onParticipantAdded, onDeliveryUpdated, onConversationUpdated, onConversationRemove, onParticipantRemove, onConversationUpdate, onMessageAdd, onMessageRemoved, onParticipantUpdated, onConversationAdded, onMessageAdded, onConversationAdd, onConversationRemoved, onParticipantUpdate, onMessageRemove, onMessageUpdated, onParticipantRemoved, onMessageUpdate or onConversationStateUpdated.

method'GET' | 'POST'
post_webhook_urlstring uri nullable

The absolute url the post-event webhook request should be sent to.

pre_webhook_urlstring uri nullable

The absolute url the pre-event webhook request should be sent to.

urlstring uri nullable

An absolute API resource URL for this webhook.