Twilio

Twilio Sinks API

The Sinks API from Twilio — 4 operation(s) for sinks.

Documentation GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/Sinks/{Sid} Get one event streams sink · Fetch sink #

Ask an LLM

“What type and status does a specific event sink have?”

“Can I see how one of my sinks is configured?”

Tell an agent

Get sink {sink}.

Show the configuration and status of event sink {sink}.

DELETE /v1/Sinks/{Sid} Delete a sink · Delete sink #

Ask an LLM

“How do I get rid of an event streams destination I no longer use?”

“Can I permanently delete a sink?”

Tell an agent destructive · confirm first

Delete sink {sink}.

Permanently remove event destination {sink}.

POST /v1/Sinks/{Sid} Rename a sink · Update sink #

Ask an LLM

“How do I change the description on an existing event sink?”

“Can I relabel a sink without recreating it?”

Tell an agent

Change the description of sink {sink} to {description}.

Relabel existing event sink {sink} as {description}.

POST /v1/Sinks Create an event streams sink · Create sink #

Ask an LLM

“How do I send event stream data to a destination of my own?”

“Can I set up a new destination for events with its connection details as JSON?”

Tell an agent

Create a {sink_type} sink described as {description} with configuration {configuration}.

Set up a new event destination {description} of type {sink_type} using connection settings {configuration}.

GET /v1/Sinks List my event streams sinks · List sink #

Ask an LLM

“Which of my event sinks have failed validation?”

“Are there sinks that no subscription is using anymore?”

Tell an agent

List all my event sinks.

List sinks with status {status}.

POST /v1/Sinks/{Sid}/Test Send a test event to a sink · Create sink test #

Ask an LLM

“How do I check that my sink can actually receive events?”

“Can I fire a sample event at a destination before subscribing it to real traffic?”

Tell an agent

Send a test event to sink {sink}.

Fire a sample event at destination {sink} so I can confirm delivery.

POST /v1/Sinks/{Sid}/Validate Confirm a sink received its test event · Create sink validate #

Ask an LLM

“Once the test event arrives, how do I mark my sink as validated?”

“What do I do with the test ID my sink received?”

Tell an agent

Validate sink {sink} with test ID {test_id}.

Confirm that destination {sink} received test event {test_id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/twilio-sinks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Twilio - Events Sinks API
  description: This is the public Twilio REST API.
  termsOfService: https://www.twilio.com/legal/tos
  contact:
    name: Twilio Support
    url: https://support.twilio.com
    email: support@twilio.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.52.0
servers:
- url: https://events.twilio.com
tags:
- name: Sinks
paths:
  /v1/Sinks/{Sid}:
    servers:
    - url: https://events.twilio.com
    description: Sink destination to send events to
    x-twilio:
      defaultOutputProperties:
      - date_created
      - date_updated
      - description
      - sid
      - sink_configuration
      - sink_type
      - status
      pathType: instance
      dependentProperties:
        sink_test:
          mapping:
            sid: sid
          resource_url: /v1/Sinks/{sid}/Test
        sink_validate:
          mapping:
            sid: sid
          resource_url: /v1/Sinks/{sid}/Validate
    get:
      description: Fetch a specific Sink.
      tags:
      - Sinks
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies this Sink.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.sink'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchSink
      x-maturity:
      - GA
      summary: Fetch sink
      x-summary-source: derived
    delete:
      description: Delete a specific Sink.
      tags:
      - Sinks
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies this Sink.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteSink
      x-maturity:
      - GA
      summary: Delete sink
      x-summary-source: derived
    post:
      description: Update a specific Sink
      tags:
      - Sinks
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies this Sink.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.sink'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateSink
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateSinkRequest'
      summary: Update sink
      x-summary-source: derived
  /v1/Sinks:
    servers:
    - url: https://events.twilio.com
    description: Sink destination to send events to
    x-twilio:
      defaultOutputProperties:
      - date_created
      - date_updated
      - description
      - sid
      - sink_configuration
      - sink_type
      - status
      pathType: list
      dependentProperties:
        sink_test:
          mapping:
            sid: sid
          resource_url: /v1/Sinks/{sid}/Test
        sink_validate:
          mapping:
            sid: sid
          resource_url: /v1/Sinks/{sid}/Validate
    post:
      description: Create a new Sink
      tags:
      - Sinks
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.sink'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateSink
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSinkRequest'
      summary: Create sink
      x-summary-source: derived
    get:
      description: Retrieve a paginated list of Sinks belonging to the account used to make the request.
      tags:
      - Sinks
      parameters:
      - name: InUse
        in: query
        description: A boolean query parameter filtering the results to return sinks used/not used by a subscription.
        schema:
          type: boolean
      - name: Status
        in: query
        description: A String query parameter filtering the results by status `initialized`, `validating`, `active` or `failed`.
        schema:
          type: string
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSinkResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListSink
      x-maturity:
      - GA
      summary: List sink
      x-summary-source: derived
  /v1/Sinks/{Sid}/Test:
    servers:
    - url: https://events.twilio.com
    description: Test sink
    x-twilio:
      defaultOutputProperties:
      - result
      pathType: list
      parent: /Sinks/{Sid}
      mountName: sink_test
    post:
      description: Create a new Sink Test Event for the given Sink.
      tags:
      - Sinks
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies the Sink to be Tested.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.sink.sink_test'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateSinkTest
      x-maturity:
      - GA
      summary: Create sink test
      x-summary-source: derived
  /v1/Sinks/{Sid}/Validate:
    servers:
    - url: https://events.twilio.com
    description: Validate sink
    x-twilio:
      defaultOutputProperties:
      - result
      pathType: list
      parent: /Sinks/{Sid}
      mountName: sink_validate
    post:
      description: Validate that a test event for a Sink was received.
      tags:
      - Sinks
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies the Sink being validated.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.sink.sink_validate'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateSinkValidate
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSinkValidateRequest'
      summary: Create sink validate
      x-summary-source: derived
components:
  schemas:
    UpdateSinkRequest:
      type: object
      required:
      - Description
      properties:
        Description:
          type: string
          description: A human readable description for the Sink **This value should not contain PII.**
    sink_enum_status:
      type: string
      enum:
      - initialized
      - validating
      - active
      - failed
    CreateSinkValidateRequest:
      type: object
      required:
      - TestId
      properties:
        TestId:
          type: string
          description: A 34 character string that uniquely identifies the test event for a Sink being validated.
    events.v1.sink.sink_validate:
      type: object
      properties:
        result:
          type:
          - string
          - 'null'
          description: Feedback indicating whether the given Sink was validated.
    events.v1.sink.sink_test:
      type: object
      properties:
        result:
          type:
          - string
          - 'null'
          description: Feedback indicating whether the test event was generated.
    sink_enum_sink_type:
      type: string
      enum:
      - kinesis
      - webhook
      - segment
    ListSinkResponse:
      type: object
      properties:
        sinks:
          type: array
          items:
            $ref: '#/components/schemas/events.v1.sink'
        meta:
          type: object
          properties:
            first_page_url:
              type: string
              format: uri
            next_page_url:
              type:
              - string
              - 'null'
              format: uri
            page:
              type: integer
            page_size:
              type: integer
            previous_page_url:
              type:
              - string
              - 'null'
              format: uri
            url:
              type: string
              format: uri
            key:
              type: string
    CreateSinkRequest:
      type: object
      required:
      - Description
      - SinkConfiguration
      - SinkType
      properties:
        Description:
          type: string
          description: A human readable description for the Sink **This value should not contain PII.**
        SinkConfiguration:
          description: The information required for Twilio to connect to the provided Sink encoded as JSON.
        SinkType:
          type: string
          $ref: '#/components/schemas/sink_enum_sink_type'
          description: The Sink type. Can only be "kinesis" or "webhook" currently.
    events.v1.sink:
      type: object
      properties:
        date_created:
          type:
          - string
          - 'null'
          format: date-time
          description: The date that this Sink was created, given in ISO 8601 format.
        date_updated:
          type:
          - string
          - 'null'
          format: date-time
          description: The date that this Sink was updated, given in ISO 8601 format.
        description:
          type:
          - string
          - 'null'
          description: A human readable description for the Sink
        sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
          description: A 34 character string that uniquely identifies this Sink.
        sink_configuration:
          description: The information required for Twilio to connect to the provided Sink encoded as JSON.
        sink_type:
          type:
          - string
          - 'null'
          $ref: '#/components/schemas/sink_enum_sink_type'
          description: The Sink type. Can only be "kinesis" or "webhook" currently.
        status:
          type:
          - string
          - 'null'
          $ref: '#/components/schemas/sink_enum_status'
          description: The Status of this Sink. One of `initialized`, `validating`, `active` or `failed`.
        url:
          type:
          - string
          - 'null'
          format: uri
          description: The URL of this resource.
        links:
          type:
          - object
          - 'null'
          format: uri-map
          description: Contains a dictionary of URL links to nested resources of this Sink.
  securitySchemes:
    accountSid_authToken:
      type: http
      scheme: basic
x-maturity:
- name: GA
  description: This product is Generally Available.

Twilio Sinks API

Operations 7

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification