Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const webhookDelivery = await client.webhookDeliveries.retrieve('C9C0797E-901D-4349-A33C-C2C8F31A92C2');

console.log(webhookDelivery.data);

{
  "data": {
    "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "record_type": "webhook_delivery",
    "status": "delivered",
    "webhook": {
      "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": "2020-08-10T14:00:00.000Z",
    "finished_at": "2020-08-10T14:00:05.595Z",
    "attempts": [
      {
        "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
        ]
      }
    ]
  }
}

GET

webhook_deliveries

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const webhookDelivery = await client.webhookDeliveries.retrieve('C9C0797E-901D-4349-A33C-C2C8F31A92C2');

console.log(webhookDelivery.data);

{
  "data": {
    "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    "record_type": "webhook_delivery",
    "status": "delivered",
    "webhook": {
      "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": "2020-08-10T14:00:00.000Z",
    "finished_at": "2020-08-10T14:00:05.595Z",
    "attempts": [
      {
        "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
        ]
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Uniquely identifies the webhook_delivery.

Example:

"C9C0797E-901D-4349-A33C-C2C8F31A92C2"

Response

Webhook delivery record.

data

object

Record of all attempts to deliver a webhook.

Show child attributes

data.id

string<uuid>

Uniquely identifies the webhook_delivery record.

Example:

"f5586561-8ff0-4291-a0ac-84fe544797bd"

data.user_id

string<uuid>

Uniquely identifies the user that owns the webhook_delivery record.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.record_type

string

Identifies the type of the resource.

Example:

"webhook_delivery"

data.status

enum<string>

Delivery status: 'delivered' when successfuly delivered or 'failed' if all attempts have failed.

Available options:

delivered,

failed

data.webhook

object

Original webhook JSON data. Payload fields vary according to event type.

Show child attributes

data.webhook.record_type

enum<string>

Identifies the type of the resource.

Available options:

event

Example:

"event"

data.webhook.event_type

string

The type of event being delivered.

Example:

"webhook.command"

data.webhook.id

string<uuid>

Identifies the type of resource.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.webhook.occurred_at

string<date-time>

ISO 8601 datetime of when the event occurred.

Example:

"2018-02-02T22:25:27.521992Z"

data.webhook.payload

object

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" }
}

data.started_at

string<date-time>

ISO 8601 timestamp indicating when the first request attempt was initiated.

Example:

"2020-08-10T14:00:00.000Z"

data.finished_at

string<date-time>

ISO 8601 timestamp indicating when the last webhook response has been received.

Example:

"2020-08-10T14:00:05.595Z"

data.attempts

object[]

Detailed delivery attempts, ordered by most recent.

Show child attributes

data.attempts.status

enum<string>

Available options:

delivered,

failed

data.attempts.started_at

string<date-time>

ISO 8601 timestamp indicating when the attempt was initiated.

data.attempts.finished_at

string<date-time>

ISO 8601 timestamp indicating when the attempt has finished.

data.attempts.http

object

HTTP request and response information.

Show child attributes

data.attempts.http.request

object

Request details.

Show child attributes

data.attempts.http.request.url

string

Example:

"https://example.com/webhooks"

data.attempts.http.request.headers

string[][]

List of headers, limited to 10kB.

Example:

[["header_name", "header_value"]]

data.attempts.http.response

object

Response details, optional.

Show child attributes

data.attempts.http.response.status

integer

Example:

200

data.attempts.http.response.headers

string[][]

List of headers, limited to 10kB.

Example:

[["header_name", "header_value"]]

data.attempts.http.response.body

string

Raw response body, limited to 10kB.

data.attempts.errors

integer[]

Webhook delivery error codes.

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]
  }
]

List webhook deliveries List Audit Logs

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Find webhook_delivery details by ID

Authorizations

Path Parameters

Response