Retrieve a list of all webhooks scoped to the conversation

GET /v1/Conversations/{ConversationSid}/Webhooks
Account sid auth token

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

Retrieve a list of all webhooks scoped to the conversation

Path parameters

  • ConversationSid string Required

    The unique ID of the Conversation for this webhook.

Query parameters

  • PageSize integer(int64)

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

    Minimum value is 1, maximum value is 5.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • webhooks array[object]
      Hide webhooks attributes Show webhooks attributes object
      • 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}$.

      • 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}$.

      • 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}$.

      • target string | null

        The target of this webhook: webhook, studio, trigger

      • url string(uri) | null

        An absolute API resource URL for this webhook.

      • configuration

        The configuration of this webhook. Is defined based on target.

      • 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.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Conversations/{ConversationSid}/Webhooks 
curl \
 --request GET 'https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Webhooks' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "webhooks",
    "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0",
    "page": 0,
    "page_size": 5,
    "next_page_url": null,
    "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0",
    "previous_page_url": null
  },
  "webhooks": [
    {
      "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "target": "webhook",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "configuration": {
        "url": "https://example.com",
        "method": "get",
        "filters": [
          "onMessageSent",
          "onConversationDestroyed"
        ]
      },
      "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    {
      "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "target": "trigger",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "configuration": {
        "url": "https://example.com",
        "method": "post",
        "filters": [
          "keyword1",
          "keyword2"
        ]
      },
      "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    {
      "sid": "WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "target": "studio",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "configuration": {
        "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "conversation_sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "meta": {
    "key": "webhooks",
    "url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0",
    "page": 0,
    "page_size": 5,
    "next_page_url": null,
    "first_page_url": "https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0",
    "previous_page_url": null
  },
  "webhooks": []
}