Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Notifications API

Notification settings operations

Telnyx Notifications API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notifications. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 8 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

16 operations 8 paths 8 schemas 3 DELETE8 GET2 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Notifications API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 16

Across 8 paths, the API surfaces 16 operations — 3 DELETE, 8 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Notifications 16

Notification settings operations

GET
/notification_channels
List notification channels
ListNotificationChannels 2 params → 200400422500
POST
/notification_channels
Create a notification channel
CreateNotificationChannels body → 200400422500
DELETE
/notification_channels/{id}
Delete a notification channel
DeleteNotificationChannel 1 param → 200400422500
GET
/notification_channels/{id}
Get a notification channel
GetNotificationChannel 1 param → 200400404422500
PATCH
/notification_channels/{id}
Update a notification channel
UpdateNotificationChannel 1 param body → 200400422500
GET
/notification_event_conditions
List all Notifications Events Conditions
FindNotificationsEventsConditions 2 params → 200400422500
GET
/notification_events
List all Notifications Events
FindNotificationsEvents 1 param → 200400422500
GET
/notification_profiles
List all Notifications Profiles
FindNotificationsProfiles 1 param → 200400422500
POST
/notification_profiles
Create a notification profile
CreateNotificationProfile body → 200400422500
DELETE
/notification_profiles/{id}
Delete a notification profile
DeleteNotificationProfile 1 param → 200400422500
GET
/notification_profiles/{id}
Get a notification profile
GetNotificationProfile 1 param → 200400404422500
PATCH
/notification_profiles/{id}
Update a notification profile
UpdateNotificationProfile 1 param body → 200400422500
GET
/notification_settings
List notification settings
ListNotificationSettings 2 params → 200400422500
POST
/notification_settings
Add a Notification Setting
CreateNotificationSetting body → 200201400422500
DELETE
/notification_settings/{id}
Delete a notification setting
DeleteNotificationSetting 1 param → 200201400422500
GET
/notification_settings/{id}
Get a notification setting
GetNotificationSetting 1 param → 200400404422500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are NotificationEventCondition (12 properties), NotificationSetting (10 properties), NotificationEvent (6 properties), NotificationChannel (6 properties). Each schema is shown below with its type and property counts.

notifications_Error
object
5 properties 2 required
NotificationEvent
object
An object representing the available notifications.
6 properties
PaginationMeta
object
4 properties
notifications_Errors
object
1 property
NotificationChannel
object
A Notification Channel
6 properties
NotificationEventCondition
object
12 properties
NotificationProfile
object
A Collection of Notification Channels
4 properties
NotificationSetting
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-notifications-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API