Twilio

Twilio Subscriptions API

The Subscriptions API from Twilio — 4 operation(s) for subscriptions.

Documentation GitHub OpenAPI

Business capability

Webhook & Event Subscription Management BC-4270.80

Operations 10

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/Subscriptions/{SubscriptionSid}/SubscribedEvents List the event types in a subscription · List subscribed event #

Ask an LLM

“Which event types is one of my Event Streams subscriptions receiving?”

“Can I see every event type a subscription is signed up for, with its schema version?”

Tell an agent

List the event types subscribed on subscription {subscription}.

Show all subscribed events for {subscription}, {page_size} per page.

POST /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents Add an event type to a subscription · Create subscribed event #

Ask an LLM

“How do I start receiving one more event type on a subscription I already have?”

“Can I pick the schema version when adding an event type to a subscription?”

Tell an agent

Add event type {type} to subscription {subscription}.

Subscribe {subscription} to {type} events using schema version {schema_version}.

GET /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type} Check one event type on a subscription · Fetch subscribed event #

Ask an LLM

“Is a particular event type included in my subscription, and on which schema version?”

“What schema version does a subscribed event type currently use?”

Tell an agent

Show event type {type} on subscription {subscription}.

Tell me the schema version subscription {subscription} uses for {type}.

POST /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type} Change a subscribed event's schema version · Update subscribed event #

Ask an LLM

“Can I move an event type I'm already subscribed to onto a newer schema version?”

“How do I upgrade the payload schema for one subscribed event type?”

Tell an agent

Switch event type {type} on subscription {subscription} to schema version {schema_version}.

Upgrade the already-subscribed {type} events in {subscription} to schema {schema_version}.

DELETE /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type} Remove an event type from a subscription · Delete subscribed event #

Ask an LLM

“How do I stop getting one event type without deleting the whole subscription?”

“Can I unsubscribe from a single noisy event type?”

Tell an agent destructive · confirm first

Remove event type {type} from subscription {subscription}.

Stop sending {type} events on {subscription}.

GET /v1/Subscriptions List my event subscriptions · List subscription #

Ask an LLM

“What Event Streams subscriptions exist on my Twilio account?”

“Which subscriptions are sending events to a particular sink?”

Tell an agent

List all my event subscriptions.

Show the subscriptions that deliver to sink {sink}.

POST /v1/Subscriptions Create an event subscription · Create subscription #

Ask an LLM

“How do I route selected account events to a sink I've set up?”

“Does the sink need to be active before I create a subscription for it?”

Tell an agent

Create a subscription {description} sending {types} events to sink {sink}.

Start streaming event types {types} into sink {sink}, described as {description}.

GET /v1/Subscriptions/{Sid} Look up an event subscription · Fetch subscription #

Ask an LLM

“How can I see which sink one of my subscriptions points at?”

“Can I pull the details of a single event subscription by its SID?”

Tell an agent

Show event subscription {subscription}.

Tell me the sink and description of subscription {subscription}.

POST /v1/Subscriptions/{Sid} Change a subscription's sink or description · Update subscription #

Ask an LLM

“Can I redirect an existing subscription to a different sink?”

“How do I rename the description on a subscription I already created?”

Tell an agent

Point subscription {subscription} at sink {sink}.

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

DELETE /v1/Subscriptions/{Sid} Delete an event subscription · Delete subscription #

Ask an LLM

“How do I stop all events flowing through a subscription at once?”

“Can I delete an entire subscription with all its event types?”

Tell an agent destructive · confirm first

Delete event subscription {subscription}.

Tear down subscription {subscription} and everything it streams.

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-subscriptions-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 Subscriptions 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: Subscriptions
paths:
  /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents:
    servers:
    - url: https://events.twilio.com
    description: Event subscribed to in the parent Subscription
    x-twilio:
      defaultOutputProperties:
      - type
      - schema_version
      - account_sid
      - subscription_sid
      pathType: list
      parent: /Subscriptions/{Sid}
    get:
      description: Retrieve a list of all Subscribed Event types for a Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: SubscriptionSid
        in: path
        description: The unique SID identifier of the Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      - 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/ListSubscribedEventResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListSubscribedEvent
      x-maturity:
      - GA
      summary: List subscribed event
      x-summary-source: derived
    post:
      description: Add an event type to a Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: SubscriptionSid
        in: path
        description: The unique SID identifier of the Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.subscription.subscribed_event'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateSubscribedEvent
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSubscribedEventRequest'
      summary: Create subscribed event
      x-summary-source: derived
  /v1/Subscriptions/{SubscriptionSid}/SubscribedEvents/{Type}:
    servers:
    - url: https://events.twilio.com
    description: Event subscribed to in the parent Subscription
    x-twilio:
      defaultOutputProperties:
      - type
      - schema_version
      - account_sid
      - subscription_sid
      pathType: instance
      parent: /Subscriptions/{Sid}
    get:
      description: Read an Event for a Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: SubscriptionSid
        in: path
        description: The unique SID identifier of the Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      - name: Type
        in: path
        description: Type of event being subscribed to.
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.subscription.subscribed_event'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchSubscribedEvent
      x-maturity:
      - GA
      summary: Fetch subscribed event
      x-summary-source: derived
    post:
      description: Update an Event for a Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: SubscriptionSid
        in: path
        description: The unique SID identifier of the Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      - name: Type
        in: path
        description: Type of event being subscribed to.
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.subscription.subscribed_event'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateSubscribedEvent
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateSubscribedEventRequest'
      summary: Update subscribed event
      x-summary-source: derived
    delete:
      description: Remove an event type from a Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: SubscriptionSid
        in: path
        description: The unique SID identifier of the Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      - name: Type
        in: path
        description: Type of event being subscribed to.
        schema:
          type: string
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteSubscribedEvent
      x-maturity:
      - GA
      summary: Delete subscribed event
      x-summary-source: derived
  /v1/Subscriptions:
    servers:
    - url: https://events.twilio.com
    description: Subscription to send Event Types to a Sink
    x-twilio:
      defaultOutputProperties:
      - account_sid
      - sid
      - sink_sid
      - date_created
      - date_updated
      pathType: list
      dependentProperties:
        subscribed_events:
          mapping:
            subscription_sid: sid
          resource_url: /v1/Subscriptions/{subscription_sid}/SubscribedEvents
    get:
      description: Retrieve a paginated list of Subscriptions belonging to the account used to make the request.
      tags:
      - Subscriptions
      parameters:
      - name: SinkSid
        in: query
        description: The SID of the sink that the list of Subscriptions should be filtered by.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
      - 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/ListSubscriptionResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListSubscription
      x-maturity:
      - GA
      summary: List subscription
      x-summary-source: derived
    post:
      description: Create a new Subscription.
      tags:
      - Subscriptions
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.subscription'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateSubscription
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionRequest'
      summary: Create subscription
      x-summary-source: derived
  /v1/Subscriptions/{Sid}:
    servers:
    - url: https://events.twilio.com
    description: Subscription to send Event Types to a Sink
    x-twilio:
      defaultOutputProperties:
      - account_sid
      - sid
      - sink_sid
      - date_created
      - date_updated
      pathType: instance
      dependentProperties:
        subscribed_events:
          mapping:
            subscription_sid: sid
          resource_url: /v1/Subscriptions/{subscription_sid}/SubscribedEvents
    get:
      description: Fetch a specific Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies this Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.subscription'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchSubscription
      x-maturity:
      - GA
      summary: Fetch subscription
      x-summary-source: derived
    post:
      description: Update a Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies this Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/events.v1.subscription'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateSubscription
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionRequest'
      summary: Update subscription
      x-summary-source: derived
    delete:
      description: Delete a specific Subscription.
      tags:
      - Subscriptions
      parameters:
      - name: Sid
        in: path
        description: A 34 character string that uniquely identifies this Subscription.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteSubscription
      x-maturity:
      - GA
      summary: Delete subscription
      x-summary-source: derived
components:
  schemas:
    ListSubscriptionResponse:
      type: object
      properties:
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/events.v1.subscription'
        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
    events.v1.subscription.subscribed_event:
      type: object
      properties:
        account_sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          description: The unique SID identifier of the Account.
        type:
          type:
          - string
          - 'null'
          description: Type of event being subscribed to.
        schema_version:
          type:
          - integer
          - 'null'
          description: The schema version that the Subscription should use.
        subscription_sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
          description: The unique SID identifier of the Subscription.
        url:
          type:
          - string
          - 'null'
          format: uri
          description: The URL of this resource.
    events.v1.subscription:
      type: object
      properties:
        account_sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          description: The unique SID identifier of the Account.
        sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^DF[0-9a-fA-F]{32}$
          description: A 34 character string that uniquely identifies this Subscription.
        date_created:
          type:
          - string
          - 'null'
          format: date-time
          description: The date that this Subscription was created, given in ISO 8601 format.
        date_updated:
          type:
          - string
          - 'null'
          format: date-time
          description: The date that this Subscription was updated, given in ISO 8601 format.
        description:
          type:
          - string
          - 'null'
          description: A human readable description for the Subscription
        sink_sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
          description: The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.
        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 Subscription.
    UpdateSubscriptionRequest:
      type: object
      properties:
        Description:
          type: string
          description: A human readable description for the Subscription.
        SinkSid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
          description: The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.
    CreateSubscriptionRequest:
      type: object
      required:
      - Description
      - SinkSid
      - Types
      properties:
        Description:
          type: string
          description: A human readable description for the Subscription **This value should not contain PII.**
        SinkSid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^DG[0-9a-fA-F]{32}$
          description: The SID of the sink that events selected by this subscription should be sent to. Sink must be active for the subscription to be created.
        Types:
          type: array
          items: {}
          description: An array of objects containing the subscribed Event Types
    CreateSubscribedEventRequest:
      type: object
      required:
      - Type
      properties:
        Type:
          type: string
          description: Type of event being subscribed to.
        SchemaVersion:
          type: integer
          description: The schema version that the Subscription should use.
    ListSubscribedEventResponse:
      type: object
      properties:
        types:
          type: array
          items:
            $ref: '#/components/schemas/events.v1.subscription.subscribed_event'
        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
    UpdateSubscribedEventRequest:
      type: object
      properties:
        SchemaVersion:
          type: integer
          description: The schema version that the Subscription should use.
  securitySchemes:
    accountSid_authToken:
      type: http
      scheme: basic
x-maturity:
- name: GA
  description: This product is Generally Available.

Twilio Subscriptions API

Operations 10

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification