Retrieve a list of all webhooks scoped to the conversation

GET /v1/Conversations/{ConversationSid}/Webhooks

A Scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation.

Path parameters

ConversationSid string Required

The unique ID of the Conversation for this webhook.

Query parameters

PageSize integer

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum value is 1, maximum value is 1000.

Responses

200

OK
Hide response attributes Show response attributes object
- meta object
  
  Hide meta attributes Show meta attributes object
  
  first_page_url string(uri)
  
  key string
  
  next_page_url string(uri)
  
  page integer
  
  page_size integer
  
  previous_page_url string(uri)
  
  url string(uri)
- webhooks array[object]
  
  Hide webhooks attributes Show webhooks attributes array[object]
  
  account_sid string | null
  
  The unique ID of the Account responsible for this conversation.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
  
  configuration
  
  The configuration of this webhook.
  
  conversation_sid string | null
  
  The unique ID of the Conversation for this webhook.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
  
  date_created string(date-time) | null
  
  The date that this resource was created.
  
  date_updated string(date-time) | null
  
  The date that this resource was last updated.
  
  sid string | null
  
  A 34 character string that uniquely identifies this resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WH[0-9a-fA-F]{32}$.
  
  target string | null
  
  The target of this webhook.
  
  url string(uri) | null
  
  An absolute URL for this webhook.

GET /v1/Conversations/{ConversationSid}/Webhooks

curl \
 -X GET https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks \
 --user "username:password"

Response examples (200)

{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "webhooks": [
    {
      "account_sid": "string",
      "conversation_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "sid": "string",
      "target": "string",
      "url": "https://example.com"
    }
  ]
}

Response examples (200)

{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "webhooks": [
    {
      "account_sid": "string",
      "conversation_sid": "string",
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "sid": "string",
      "target": "string",
      "url": "https://example.com"
    }
  ]
}