Telnyx

Authorizations

Authorization

string

header

required

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

Headers

telnyx-timestamp

integer<int64>

required

Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp Unix timestamp for replay attack prevention

telnyx-signature-ed25519

string

required

Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature Ed25519 signature of timestamp|payload for verification

Body

application/json

record_type

enum<string>

Identifies the type of the resource.

Available options:

event

Example:

"event"

string<uuid>

Identifies the type of resource.

Example:

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

event_type

enum<string>

The type of event being delivered.

Available options:

fax.sending.started

Example:

"fax.sending.started"

payload

object

Show child attributes

payload.connection_id

string

The ID of the connection used to send the fax.

Example:

"234423"

payload.direction

enum<string>

The direction of the fax.

Available options:

inbound,

outbound

Example:

"outbound"

payload.fax_id

string<uuid>

Identifies the fax.

Example:

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

payload.original_media_url

string

The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted

Example:

"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"

payload.media_name

string

The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_name and media_url/contents can't be submitted together.

Example:

"my_media_uploaded_to_media_storage_api"

payload.to

string

The phone number, in E.164 format, the fax will be sent to or SIP URI

Example:

"+13127367276"

payload.from

string

The phone number, in E.164 format, the fax will be sent from.

Example:

"+13125790015"

payload.user_id

string<uuid>

Identifier of the user to whom the fax belongs

Example:

"yfff7c54-4df3-4bca-a65a-3da1ecc777f0"

payload.status

enum<string>

The status of the fax.

Available options:

sending

Example:

"sending"

payload.client_state

string

State received from a command.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

Response

200

The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup