Create channel webhook

POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks

TODO: Resource-level docs

Path parameters

ServiceSid string Required
ChannelSid string Required

Body

Configuration.Filters array[string]
Configuration.FlowSid string

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.
Configuration.Method string

Values are GET or POST.
Configuration.RetryCount integer
Configuration.Triggers array[string]
Configuration.Url string
Type string Required

Values are webhook, trigger, or studio.

Responses

201

Created
Hide response attributes Show response attributes object
- account_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- channel_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
- configuration
- date_created string(date-time) | null
- date_updated string(date-time) | null
- service_sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- sid string | null
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WH[0-9a-fA-F]{32}$.
- type string | null
- url string(uri) | null

POST /v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks

curl \
 -X POST https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Webhooks \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Configuration.Filters=string&Configuration.FlowSid=string&Configuration.Method=GET&Configuration.RetryCount=42&Configuration.Triggers=string&Configuration.Url=string&Type=webhook'

Request example

{
  "Configuration.Filters": [
    "string"
  ],
  "Configuration.FlowSid": "string",
  "Configuration.Method": "GET",
  "Configuration.RetryCount": 42,
  "Configuration.Triggers": [
    "string"
  ],
  "Configuration.Url": "string",
  "Type": "webhook"
}

Request examples

{
  "Configuration.Filters": [
    "string"
  ],
  "Configuration.FlowSid": "string",
  "Configuration.Method": "GET",
  "Configuration.RetryCount": 42,
  "Configuration.Triggers": [
    "string"
  ],
  "Configuration.Url": "string",
  "Type": "webhook"
}

Response examples (201)

{
  "account_sid": "string",
  "channel_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "service_sid": "string",
  "sid": "string",
  "type": "string",
  "url": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "channel_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "service_sid": "string",
  "sid": "string",
  "type": "string",
  "url": "https://example.com"
}