Retrieve a paginated list of Sinks belonging to the account used to make the request.

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://twilio.demo.bump-doc.com/doc/events/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"Events MCP server": {
  "url": "https://twilio.demo.bump-doc.com/doc/events/mcp"
}
Close
GET /v1/Sinks
Account sid auth token

Sink destination to send events to

Retrieve a paginated list of Sinks belonging to the account used to make the request.

Query parameters

  • InUse boolean

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

  • Status string

    A String query parameter filtering the results by status initialized, validating, active or failed.

  • PageSize integer(int64)

    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.

  • 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
    • sinks array[object]
      Hide sinks attributes Show sinks attributes object
      • date_created string(date-time) | null

        The date that this Sink was created, given in ISO 8601 format.

      • date_updated string(date-time) | null

        The date that this Sink was updated, given in ISO 8601 format.

      • description string | null

        A human readable description for the Sink

      • sid string | null

        A 34 character string that uniquely identifies this Sink.

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

      • sink_configuration

        The information required for Twilio to connect to the provided Sink encoded as JSON.

      • sink_type string

        The Sink type. Can only be "kinesis" or "webhook" currently.

        Values are kinesis, webhook, segment, or email.

      • status string

        The Status of this Sink. One of initialized, validating, active or failed.

        Values are initialized, validating, active, or failed.

      • url string(uri) | null

        The URL of this resource.

      • links object(uri-map) | null

        Contains a dictionary of URL links to nested resources of this Sink.

    • 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/Sinks 
curl \
 --request GET 'https://events.twilio.com/v1/Sinks' \
 --user "username:password"
Response examples (200) 
{
  "sinks": [],
  "meta": {
    "page": 0,
    "page_size": 10,
    "first_page_url": "https://events.twilio.com/v1/Sinks?PageSize=10&Page=0",
    "previous_page_url": null,
    "url": "https://events.twilio.com/v1/Sinks?PageSize=10&Page=0",
    "next_page_url": null,
    "key": "sinks"
  }
}
{
  "sinks": [
    {
      "status": "initialized",
      "sink_configuration": {
        "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test",
        "role_arn": "arn:aws:iam::111111111:role/Role",
        "external_id": "1234567890"
      },
      "description": "A Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2015-07-30T19:00:00Z",
      "sink_type": "kinesis",
      "date_updated": "2015-07-30T19:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate"
      }
    },
    {
      "status": "initialized",
      "sink_configuration": {
        "arn": "arn:aws:kinesis:us-east-1:222222222:stream/test",
        "role_arn": "arn:aws:iam::111111111:role/Role",
        "external_id": "1234567890"
      },
      "description": "ANOTHER Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "date_created": "2015-07-30T20:00:00Z",
      "sink_type": "kinesis",
      "date_updated": "2015-07-30T20:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate"
      }
    },
    {
      "status": "active",
      "sink_configuration": {
        "destination": "http://example.org/webhook",
        "method": "POST",
        "batch_events": true
      },
      "description": "A webhook Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "date_created": "2015-07-30T21:00:00Z",
      "sink_type": "webhook",
      "date_updated": "2015-07-30T21:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate"
      }
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 20,
    "first_page_url": "https://events.twilio.com/v1/Sinks?PageSize=20&Page=0",
    "previous_page_url": null,
    "url": "https://events.twilio.com/v1/Sinks?PageSize=20&Page=0",
    "next_page_url": null,
    "key": "sinks"
  }
}
{
  "sinks": [
    {
      "status": "initialized",
      "sink_configuration": {
        "arn": "arn:aws:kinesis:us-east-1:111111111:stream/test",
        "role_arn": "arn:aws:iam::111111111:role/Role",
        "external_id": "1234567890"
      },
      "description": "A Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2015-07-30T19:00:00Z",
      "sink_type": "kinesis",
      "date_updated": "2015-07-30T19:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Validate"
      }
    },
    {
      "status": "initialized",
      "sink_configuration": {
        "arn": "arn:aws:kinesis:us-east-1:222222222:stream/test",
        "role_arn": "arn:aws:iam::111111111:role/Role",
        "external_id": "1234567890"
      },
      "description": "ANOTHER Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "date_created": "2015-07-30T20:00:00Z",
      "sink_type": "kinesis",
      "date_updated": "2015-07-30T20:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab/Validate"
      }
    },
    {
      "status": "active",
      "sink_configuration": {
        "destination": "http://example.org/webhook",
        "method": "POST",
        "batch_events": true
      },
      "description": "A webhook Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "date_created": "2015-07-30T21:00:00Z",
      "sink_type": "webhook",
      "date_updated": "2015-07-30T21:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate"
      }
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 20,
    "first_page_url": "https://events.twilio.com/v1/Sinks?InUse=true&PageSize=20&Page=0",
    "previous_page_url": null,
    "url": "https://events.twilio.com/v1/Sinks?InUse=true&PageSize=20&Page=0",
    "next_page_url": null,
    "key": "sinks"
  }
}
{
  "sinks": [
    {
      "status": "active",
      "sink_configuration": {
        "destination": "http://example.org/webhook",
        "method": "POST",
        "batch_events": true
      },
      "description": "A webhook Sink",
      "sid": "DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "date_created": "2015-07-30T21:00:00Z",
      "sink_type": "webhook",
      "date_updated": "2015-07-30T21:00:00Z",
      "url": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "links": {
        "sink_test": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Test",
        "sink_validate": "https://events.twilio.com/v1/Sinks/DGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac/Validate"
      }
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 20,
    "first_page_url": "https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0",
    "previous_page_url": null,
    "url": "https://events.twilio.com/v1/Sinks?Status=active&PageSize=20&Page=0",
    "next_page_url": null,
    "key": "sinks"
  }
}