<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Account Notifications - JavaScript

Installation

npm install [email protected]

Setup

import Telnyx from 'telnyx';

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

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

List notification channels

List notification channels.

GET /notification_channels

// Automatically fetches more pages as needed.
for await (const notificationChannel of client.notificationChannels.list()) {
  console.log(notificationChannel.id);
}

Returns: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

Create a notification channel

Create a notification channel.

POST /notification_channels

Optional: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

const notificationChannel = await client.notificationChannels.create({
    channel_type_id: 'webhook',
    channel_destination: 'https://example.com/webhooks',
});

console.log(notificationChannel.data);

Returns: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

Get a notification channel

Get a notification channel.

GET /notification_channels/{id}

const notificationChannel = await client.notificationChannels.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationChannel.data);

Returns: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

Update a notification channel

Update a notification channel.

PATCH /notification_channels/{id}

Optional: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

const notificationChannel = await client.notificationChannels.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationChannel.data);

Returns: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

Delete a notification channel

Delete a notification channel.

DELETE /notification_channels/{id}

const notificationChannel = await client.notificationChannels.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationChannel.data);

Returns: channeldestination (string), channeltypeid (enum: sms, voice, email, webhook), createdat (date-time), id (string), notificationprofileid (string), updated_at (date-time)

List all Notifications Events Conditions

Returns a list of your notifications events conditions.

GET /notificationeventconditions

// Automatically fetches more pages as needed.
for await (const notificationEventConditionListResponse of client.notificationEventConditions.list()) {
  console.log(notificationEventConditionListResponse.id);
}

Returns: allowmultiplechannels (boolean), associatedrecordtype (enum: account, phonenumber), asynchronous (boolean), createdat (date-time), description (string), enabled (boolean), id (string), name (string), notificationeventid (string), parameters (array[object]), supportedchannels (array[string]), updatedat (date-time)

List all Notifications Events

Returns a list of your notifications events.

GET /notification_events

// Automatically fetches more pages as needed.
for await (const notificationEventListResponse of client.notificationEvents.list()) {
  console.log(notificationEventListResponse.id);
}

Returns: createdat (date-time), enabled (boolean), id (string), name (string), notificationcategory (string), updated_at (date-time)

List all Notifications Profiles

Returns a list of your notifications profiles.

GET /notification_profiles

// Automatically fetches more pages as needed.
for await (const notificationProfile of client.notificationProfiles.list()) {
  console.log(notificationProfile.id);
}

Returns: createdat (date-time), id (string), name (string), updatedat (date-time)

Create a notification profile

Create a notification profile.

POST /notification_profiles

Optional: createdat (date-time), id (string), name (string), updatedat (date-time)

const notificationProfile = await client.notificationProfiles.create({
    name: 'My Notification Profile',
});

console.log(notificationProfile.data);

Returns: createdat (date-time), id (string), name (string), updatedat (date-time)

Get a notification profile

Get a notification profile.

GET /notification_profiles/{id}

const notificationProfile = await client.notificationProfiles.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationProfile.data);

Returns: createdat (date-time), id (string), name (string), updatedat (date-time)

Update a notification profile

Update a notification profile.

PATCH /notification_profiles/{id}

Optional: createdat (date-time), id (string), name (string), updatedat (date-time)

const notificationProfile = await client.notificationProfiles.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationProfile.data);

Returns: createdat (date-time), id (string), name (string), updatedat (date-time)

Delete a notification profile

Delete a notification profile.

DELETE /notification_profiles/{id}

const notificationProfile = await client.notificationProfiles.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationProfile.data);

Returns: createdat (date-time), id (string), name (string), updatedat (date-time)

List notification settings

List notification settings.

GET /notification_settings

// Automatically fetches more pages as needed.
for await (const notificationSetting of client.notificationSettings.list()) {
  console.log(notificationSetting.id);
}

Returns: associatedrecordtype (string), associatedrecordtypevalue (string), createdat (date-time), id (string), notificationchannelid (string), notificationeventconditionid (string), notificationprofileid (string), parameters (array[object]), status (enum: enabled, enable-received, enable-pending, enable-submitted, delete-received, delete-pending, delete-submitted, deleted), updatedat (date-time)

Add a Notification Setting

Add a notification setting.

POST /notification_settings

Optional: associatedrecordtype (string), associatedrecordtypevalue (string), createdat (date-time), id (string), notificationchannelid (string), notificationeventconditionid (string), notificationprofileid (string), parameters (array[object]), status (enum: enabled, enable-received, enable-pending, enable-submitted, delete-received, delete-pending, delete-submitted, deleted), updatedat (date-time)

const notificationSetting = await client.notificationSettings.create();

console.log(notificationSetting.data);

Returns: associatedrecordtype (string), associatedrecordtypevalue (string), createdat (date-time), id (string), notificationchannelid (string), notificationeventconditionid (string), notificationprofileid (string), parameters (array[object]), status (enum: enabled, enable-received, enable-pending, enable-submitted, delete-received, delete-pending, delete-submitted, deleted), updatedat (date-time)

Get a notification setting

Get a notification setting.

GET /notification_settings/{id}

const notificationSetting = await client.notificationSettings.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationSetting.data);

Returns: associatedrecordtype (string), associatedrecordtypevalue (string), createdat (date-time), id (string), notificationchannelid (string), notificationeventconditionid (string), notificationprofileid (string), parameters (array[object]), status (enum: enabled, enable-received, enable-pending, enable-submitted, delete-received, delete-pending, delete-submitted, deleted), updatedat (date-time)

Delete a notification setting

Delete a notification setting.

DELETE /notification_settings/{id}

const notificationSetting = await client.notificationSettings.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(notificationSetting.data);

Returns: associatedrecordtype (string), associatedrecordtypevalue (string), createdat (date-time), id (string), notificationchannelid (string), notificationeventconditionid (string), notificationprofileid (string), parameters (array[object]), status (enum: enabled, enable-received, enable-pending, enable-submitted, delete-received, delete-pending, delete-submitted, deleted), updatedat (date-time)