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

Update a specific Webhook.

Servers

Path parameters

Name Type Required Description
ChatServiceSid String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
PreWebhookUrl String No

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

PostWebhookUrl String No

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

Filters[] Array No

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 String No

The HTTP method to be used when sending a webhook request. One of GET or POST.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.