Telnyx Webhooks API

Webhooks operations

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 2

GET /webhook_deliveries List webhook deliveries #
GET /webhook_deliveries/{id} Find webhook_delivery details by 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/telnyx:telnyx-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

telnyx-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Telnyx Webhooks API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Webhooks across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Webhooks
  description: Webhooks operations
paths:
  /webhook_deliveries:
    get:
      description: Lists webhook_deliveries for the authenticated user
      summary: List webhook deliveries
      operationId: GetWebhookDeliveries
      tags:
      - Webhooks
      parameters:
      - $ref: '#/components/parameters/PageConsolidated'
      - name: filter
        in: query
        style: deepObject
        explode: true
        required: false
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[status][eq], filter[event_type], filter[webhook][contains], filter[attempts][contains], filter[started_at][gte], filter[started_at][lte], filter[finished_at][gte], filter[finished_at][lte]'
        schema:
          type: object
          properties:
            status:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                  - delivered
                  - failed
                  example: delivered
                  description: Return only webhook_deliveries matching the given `status`
            event_type:
              type: string
              example: call_initiated,call.initiated
              description: Return only webhook_deliveries matching the given value of `event_type`. Accepts multiple values separated by a `,`.
            webhook:
              type: object
              properties:
                contains:
                  type: string
                  example: call.initiated
                  description: Return only webhook deliveries whose `webhook` component contains the given text
            attempts:
              type: object
              properties:
                contains:
                  type: string
                  example: https://fallback.example.com/webhooks
                  description: Return only webhook_deliveries whose `attempts` component contains the given text
            started_at:
              type: object
              properties:
                gte:
                  type: string
                  example: '2019-03-29T11:10:00Z'
                  description: Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime
                lte:
                  type: string
                  example: '2019-03-29T11:10:00Z'
                  description: Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime
            finished_at:
              type: object
              properties:
                gte:
                  type: string
                  example: '2019-03-29T11:10:00Z'
                  description: Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime
                lte:
                  type: string
                  example: '2019-03-29T11:10:00Z'
                  description: Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime
      responses:
        '200':
          description: A paginated array of webhook_delivery attempts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/webhook_delivery'
                  meta:
                    $ref: '#/components/schemas/PaginationMetaSimple'
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable entity
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /webhook_deliveries/{id}:
    get:
      summary: Find webhook_delivery details by ID
      description: Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.
      operationId: GetWebhookDelivery
      tags:
      - Webhooks
      parameters:
      - name: id
        in: path
        required: true
        description: Uniquely identifies the webhook_delivery.
        schema:
          type: string
          format: uuid
          example: C9C0797E-901D-4349-A33C-C2C8F31A92C2
      responses:
        '200':
          description: Webhook delivery record.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/webhook_delivery'
        '401':
          description: Unauthorized
        '404':
          description: WebhookDelivery not found
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    attempt:
      description: Webhook delivery attempt details.
      properties:
        status:
          type: string
          enum:
          - delivered
          - failed
        started_at:
          description: ISO 8601 timestamp indicating when the attempt was initiated.
          type: string
          format: date-time
        finished_at:
          description: ISO 8601 timestamp indicating when the attempt has finished.
          type: string
          format: date-time
        http:
          $ref: '#/components/schemas/http'
        errors:
          description: Webhook delivery error codes.
          type: array
          items:
            type: integer
      example:
      - status: delivered
        started_at: '2020-08-10T14:00:05.364Z'
        finished_at: '2020-08-10T14:00:05.595Z'
        http:
          request:
            url: https://fallback.example.com/webhooks
            headers:
            - - Accept
              - '*/*'
          response:
            status: 200
            headers:
            - - Content-Type
              - text/html
            body: All good.
      - status: failed
        started_at: '2020-08-10T14:00:05.004Z'
        finished_at: '2020-08-10T14:00:05.360Z'
        http:
          request:
            url: https://typo.example.com/webhooks
            headers:
            - - Accept
              - '*/*'
          response:
            status: 404
            headers:
            - - Content-Type
              - text/html
            - - Pragma
              - no-cache
            body: Oops. Not found.
        errors:
        - 75499
      - status: failed
        started_at: '2020-08-10T14:00:00.000Z'
        finished_at: '2020-08-10T14:00:05.000Z'
        http:
          request:
            url: https://slow.example.com/webhooks
            headers:
            - 'Accept: */*'
          reponse: null
        errors:
        - code: '75001'
          title: Could not resolve name
          detail: Unable to resolve the webhook URL domain name
    PaginationMetaSimple:
      type: object
      properties:
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
    http_headers:
      description: List of headers, limited to 10kB.
      type: array
      example:
      - - header_name
        - header_value
      items:
        type: array
        items:
          type: string
    webhook_delivery:
      description: Record of all attempts to deliver a webhook.
      properties:
        id:
          description: Uniquely identifies the webhook_delivery record.
          type: string
          format: uuid
          example: f5586561-8ff0-4291-a0ac-84fe544797bd
        user_id:
          description: Uniquely identifies the user that owns the webhook_delivery record.
          type: string
          format: uuid
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        record_type:
          description: Identifies the type of the resource.
          type: string
          example: webhook_delivery
        status:
          description: 'Delivery status: ''delivered'' when successfuly delivered or ''failed'' if all attempts have failed.'
          enum:
          - delivered
          - failed
          type: string
        webhook:
          description: Original webhook JSON data. Payload fields vary according to event type.
          type: object
          properties:
            record_type:
              type: string
              example: event
              enum:
              - event
              description: Identifies the type of the resource.
            event_type:
              type: string
              example: webhook.command
              description: The type of event being delivered.
            id:
              type: string
              format: uuid
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              description: Identifies the type of resource.
            occurred_at:
              type: string
              format: date-time
              example: '2018-02-02T22:25:27.521992Z'
              description: ISO 8601 datetime of when the event occurred.
            payload:
              type: object
              additionalProperties: true
          example:
            record_type: event
            id: C9C0797E-901D-4349-A33C-C2C8F31A92C2
            event_type: call_initiated
            occurred_at: '2020-08-10T13:02:01.000Z'
            payload:
              useful: information
        started_at:
          description: ISO 8601 timestamp indicating when the first request attempt was initiated.
          type: string
          format: date-time
          example: '2020-08-10T14:00:00.000Z'
        finished_at:
          description: ISO 8601 timestamp indicating when the last webhook response has been received.
          type: string
          format: date-time
          example: '2020-08-10T14:00:05.595Z'
        attempts:
          description: Detailed delivery attempts, ordered by most recent.
          type: array
          items:
            $ref: '#/components/schemas/attempt'
          example:
          - status: delivered
            started_at: '2020-08-10T14:00:05.364Z'
            finished_at: '2020-08-10T14:00:05.595Z'
            http:
              request:
                url: https://fallback.example.com/webhooks
                headers:
                - - Accept
                  - '*/*'
              response:
                status: 200
                headers:
                - - Content-Type
                  - text/html
                body: All good.
          - status: failed
            started_at: '2020-08-10T14:00:05.004Z'
            finished_at: '2020-08-10T14:00:05.360Z'
            http:
              request:
                url: https://typo.example.com/webhooks
                headers:
                - - Accept
                  - '*/*'
              response:
                status: 404
                headers:
                - - Content-Type
                  - text/html
                - - Pragma
                  - no-cache
                body: Oops. Not found.
            errors:
            - 75499
    http:
      description: HTTP request and response information.
      properties:
        request:
          description: Request details.
          properties:
            url:
              type: string
              example: https://example.com/webhooks
            headers:
              $ref: '#/components/schemas/http_headers'
        response:
          description: Response details, optional.
          type: object
          properties:
            status:
              type: integer
              example: 200
            headers:
              $ref: '#/components/schemas/http_headers'
            body:
              description: Raw response body, limited to 10kB.
              type: string
  parameters:
    PageConsolidated:
      name: page
      in: query
      style: deepObject
      explode: true
      description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
      schema:
        type: object
        properties:
          number:
            type: integer
            minimum: 1
            default: 1
            description: The page number to load
          size:
            type: integer
            minimum: 1
            maximum: 250
            default: 20
            description: The size of the page
  responses:
    ListWebhookDeliveriesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/webhook_delivery'
                type: array
              meta:
                $ref: '#/components/schemas/PaginationMetaSimple'
            type: object
      description: A paginated array of webhook_delivery attempts
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt