Create webhook

POST /v1/Assistants/{AssistantSid}/Webhooks

TODO: Resource-level docs

Path parameters

Body

  • Events string Required

    The list of space-separated events that this Webhook will subscribe to.

  • UniqueName string Required

    An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the sid in the URL path to address the resource. This value must be unique and 64 characters or less in length.

  • WebhookMethod string

    The method to be used when calling the webhook's URL.

  • WebhookUrl string(uri) Required

    The URL associated with this Webhook.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

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

    • assistant_sid string | null

      The SID of the Assistant that is the parent of the resource

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

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • events string | null

      The list of space-separated events that this Webhook is subscribed to.

    • sid string | null

      The unique string that identifies the resource

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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Webhook resource

    • webhook_method string | null

      The method used when calling the webhook's URL.

    • webhook_url string(uri) | null

      The URL associated with this Webhook.
POST /v1/Assistants/{AssistantSid}/Webhooks 
curl \
 -X POST https://autopilot.twilio.com/v1/Assistants/{AssistantSid}/Webhooks \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Events=string&UniqueName=string&WebhookMethod=string&WebhookUrl=https%3A%2F%2Fexample.com'
Request example 
{
  "Events": "string",
  "UniqueName": "string",
  "WebhookMethod": "string",
  "WebhookUrl": "https://example.com"
}
Request examples 
{
  "Events": "string",
  "UniqueName": "string",
  "WebhookMethod": "string",
  "WebhookUrl": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "events": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "webhook_method": "string",
  "webhook_url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "assistant_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "events": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "webhook_method": "string",
  "webhook_url": "https://example.com"
}