POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks
Create a new webhook scoped to the conversation in a specific service
Servers
- https://conversations.twilio.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
ConversationSid |
String | Yes |
The unique ID of the Conversation for this webhook. |
ChatServiceSid |
String | Yes |
The SID of the Conversation Service the Participant resource is associated with. |
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 |
|---|---|---|---|
Configuration.Triggers[] |
Array | No |
The list of keywords, firing webhook event for this Conversation. |
Configuration.FlowSid |
String | No |
The studio flow SID, where the webhook should be sent to. |
Configuration.Url |
String | No |
The absolute url the webhook request should be sent to. |
Target |
String | Yes |
Possible values:
|
Configuration.ReplayAfter |
Integer | No |
The message index for which and it's successors the webhook will be replayed. Not set by default |
Configuration.Filters[] |
Array | No |
The list of events, firing webhook event for this Conversation. |
Configuration.Method |
String | No |
Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.