Twilio - Events
1.29.1

Base URL
https://events.twilio.com


⚠️ This is an unofficial public Twilio REST API documentation generated from an OpenAPI contract.

The source file was taken from https://github.com/twilio/twilio-oai/blob/main/spec/json/twilio_events_v1.json as a demonstration of the Bump.sh product.

This is the public Twilio REST API.

This is version 1.29.1 of this API documentation. Last update on May 24, 2022.

This API is provided under license Apache 2.0.

Authentication

Account sid auth token (http)

Basic auth tokens are constructed with the Basic keyword, followed by a space, followed by a base64-encoded string of your username:password (separated by a : colon).

Example: send a Authorization: Basic aGVsbG86aGVsbG8= HTTP header with your requests to authenticate with the API.

Schemas

Fetch a specific schema with its nested versions

GET /v1/Schemas/{Id}

Versioned Schema definitions for Event Types

Fetch a specific schema with its nested versions.

Path parameters

  • Id string Required

    The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • id string | null

      Schema Identifier.

    • latest_version integer | null

      Latest schema version.

    • latest_version_date_created string(date-time) | null

      The date that the latest schema version was created.

    • url string(uri) | null

      The URL of this resource.

GET /v1/Schemas/{Id}
curl \
 -X GET https://events.twilio.com/v1/Schemas/{Id} \
 --user "username:password"
Response examples (200)
{
  "id": "string",
  "latest_version": 42,
  "latest_version_date_created": "2023-05-04T09:42:00+00:00",
  "links": {},
  "url": "https://example.com"
}
Response examples (200)
{
  "id": "string",
  "latest_version": 42,
  "latest_version_date_created": "2025-05-04T09:42:00Z",
  "links": {},
  "url": "https://example.com"
}

Retrieve a paginated list of versions of the schema

GET /v1/Schemas/{Id}/Versions

Version of the Schema

Retrieve a paginated list of versions of the schema.

Path parameters

  • Id string Required

    The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

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

        The date the schema version was created.

      • id string | null

        The unique identifier of the schema.

      • raw string(uri) | null
      • schema_version integer | null

        The version of this schema.

      • url string(uri) | null

        The URL of this resource.

GET /v1/Schemas/{Id}/Versions
curl \
 -X GET https://events.twilio.com/v1/Schemas/{Id}/Versions \
 --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"
  },
  "schema_versions": [
    {
      "date_created": "2023-05-04T09:42:00+00:00",
      "id": "string",
      "raw": "https://example.com",
      "schema_version": 42,
      "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"
  },
  "schema_versions": [
    {
      "date_created": "2025-05-04T09:42:00Z",
      "id": "string",
      "raw": "https://example.com",
      "schema_version": 42,
      "url": "https://example.com"
    }
  ]
}