Node.js SDK

Setup & Initialization

1. Install using one of the following package managers:

npm install pingram

yarn add pingram

pnpm add pingram

2. Import:

import { Pingram } from 'pingram';

3. Initialize:

const pingram = new Pingram({
  apiKey: 'pingram_sk_...' // Your API key from the dashboard
});

• required

Region specific example:

import { Pingram } from 'pingram';

const pingram = new Pingram({
  apiKey: 'pingram_sk_...',
  baseURL: 'https://api.eu.pingram.io'
});

Send

send()

Send a notification

// Request body only
await pingram.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Addresses

createAddress()

Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.

// Request body only
await pingram.addresses.createAddress({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

listAddresses()

Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.

// No parameters
await pingram.addresses.listAddresses();

Parameters

This endpoint does not need any parameter.

updateAddress()

Update an existing address

// Request body only
await pingram.addresses.updateAddress({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Domains

addDomain()

Request to verify a new sender domain

// Request body only
await pingram.domains.addDomain({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

deleteDomain()

Delete a sender domain or email address

// Path parameter only
await pingram.domains.deleteDomain('sender_example');

Parameters

listDomains()

Get all sender domains configured for the account

// No parameters
await pingram.domains.listDomains();

Parameters

This endpoint does not need any parameter.

Environments

createEnvironment()

Create a new environment for the account

// Request body only
await pingram.environments.createEnvironment({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

listEnvironments()

Get all environments for the authenticated account

// No parameters
await pingram.environments.listEnvironments();

Parameters

This endpoint does not need any parameter.

updateEnvironment()

Update environment settings (title, secret, disable sending, secure mode)

// Path parameter + request body
await pingram.environments.updateEnvironment('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Logs

getLogRetention()

Get log retention period in days for the account

// No parameters
await pingram.logs.getLogRetention();

Parameters

This endpoint does not need any parameter.

getLogs()

List logs for the authenticated account

// No parameters
await pingram.logs.getLogs();

Parameters

getLogsByTrackingIds()

Get logs by tracking IDs (comma-separated, max 25 IDs)

// Path parameter only
await pingram.logs.getLogsByTrackingIds('trackingIds_example');

Parameters

getLogsQueryResult()

Get results from a query ID

// Path parameter only
await pingram.logs.getLogsQueryResult('queryId_example');

Parameters

startLogsQuery()

Start a log query and return query ID for asynchronous log searching

// Request body only
await pingram.logs.startLogsQuery({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

tailLogs()

Get last 100 logs from the stream

// No parameters
await pingram.logs.tailLogs();

Parameters

This endpoint does not need any parameter.

Organization

getUsage()

Get usage for the authenticated account's organization (new billing model).

// No parameters
await pingram.organization.getUsage();

Parameters

This endpoint does not need any parameter.

getUsageHistory()

Get historical usage for the authenticated account's organization over a date range.

// No parameters
await pingram.organization.getUsageHistory();

Parameters

PushSettings

deletePushApnSettings()

Delete Apple Push Notification (APN) configuration for the current account.

// No parameters
await pingram.pushSettings.deletePushApnSettings();

Parameters

This endpoint does not need any parameter.

deletePushFcmSettings()

Delete Firebase Cloud Messaging (FCM) configuration for the current account.

// No parameters
await pingram.pushSettings.deletePushFcmSettings();

Parameters

This endpoint does not need any parameter.

getPushApnSettings()

Get Apple Push Notification (APN) configuration for the current account.

// No parameters
await pingram.pushSettings.getPushApnSettings();

Parameters

This endpoint does not need any parameter.

getPushFcmSettings()

Get Firebase Cloud Messaging (FCM) configuration for the current account.

// No parameters
await pingram.pushSettings.getPushFcmSettings();

Parameters

This endpoint does not need any parameter.

upsertPushApnSettings()

Create or update Apple Push Notification (APN) configuration for the current account.

// Request body only
await pingram.pushSettings.upsertPushApnSettings({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

upsertPushFcmSettings()

Create or update Firebase Cloud Messaging (FCM) configuration for the current account.

// Request body only
await pingram.pushSettings.upsertPushFcmSettings({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Sender

deleteSchedule()

Delete (unschedule) an already scheduled notification

// Path parameter only
await pingram.sender.deleteSchedule('trackingId_example');

Parameters

updateSchedule()

Update the body or schedule of an already scheduled notification.

// Path parameter + request body
await pingram.sender.updateSchedule('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Templates

createTemplate()

Create a new template for a notification

// Path parameter + request body
await pingram.templates.createTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

deleteTemplate()

Delete a template

// Path parameter only
await pingram.templates.deleteTemplate('notificationId_example');

Parameters

getTemplate()

Get a single template by ID

// Path parameter only
await pingram.templates.getTemplate('notificationId_example');

Parameters

listTemplates()

List all templates for a notification and channel

// Path parameter only
await pingram.templates.listTemplates('notificationId_example');

Parameters

setDefaultTemplate()

Set a template as default for specific delivery modes

// Path parameter + request body
await pingram.templates.setDefaultTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

updateTemplate()

Update a template's properties

// Path parameter + request body
await pingram.templates.updateTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Types

createNotificationType()

Create a new notification

// Request body only
await pingram.types.createNotificationType({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

deleteNotificationType()

Delete a notification

// Path parameter only
await pingram.types.deleteNotificationType('notificationId_example');

Parameters

getNotificationType()

Get a specific notification by ID

// Path parameter only
await pingram.types.getNotificationType('notificationId_example');

Parameters

listNotificationTypes()

Get all notifications for an account with their templates

// No parameters
await pingram.types.listNotificationTypes();

Parameters

This endpoint does not need any parameter.

updateNotificationType()

Update a notification's settings

// Path parameter + request body
await pingram.types.updateNotificationType('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

User

getAccountMetadata()

Get account-level metadata including logo, VAPID key, and web push status

// No parameters
await pingram.user.getAccountMetadata();

Parameters

This endpoint does not need any parameter.

getAvailableSlackChannels()

Get list of Slack channels and users for the authenticated user

// Path parameter only
await pingram.user.getAvailableSlackChannels('userId_example');

Parameters

getInAppNotifications()

Get in-app notifications for a user

// No parameters
await pingram.user.getInAppNotifications();

Parameters

getInAppUnreadCount()

Get the count of unread in-app notifications for a user

// No parameters
await pingram.user.getInAppUnreadCount();

Parameters

This endpoint does not need any parameter.

getUser()

Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.

// Path parameter only
await pingram.user.getUser('userId_example');

Parameters

identify()

Create or update a user with the given ID. Updates lastSeenTime automatically.

// Path parameter + request body
await pingram.user.identify('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

markInAppNotificationsAsSeen()

Mark in-app web notifications as seen/read for a user

// Request body only
await pingram.user.markInAppNotificationsAsSeen({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

updateInAppNotificationStatus()

Update in-app web notification status (opened, archived, clicked, etc.)

// Request body only
await pingram.user.updateInAppNotificationStatus({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties

Users

deleteUser()

Delete a user and all associated data (in-app notifications, preferences, and user record)

// Path parameter only
await pingram.users.deleteUser('userId_example');

Parameters

listUsers()

Get all users for an environment with pagination support

// No parameters
await pingram.users.listUsers();

Parameters

removeUserFromSuppression()

Remove user suppression status for a specific channel

// Path parameter only
await pingram.users.removeUserFromSuppression('userId_example');

Parameters

Webhooks

deleteEventsWebhook()

Delete the events webhook configuration for the current account/environment.

// No parameters
await pingram.webhooks.deleteEventsWebhook();

Parameters

This endpoint does not need any parameter.

getEventsWebhook()

Get the events webhook configuration for the current account/environment.

// No parameters
await pingram.webhooks.getEventsWebhook();

Parameters

This endpoint does not need any parameter.

upsertEventsWebhook()

Create or update the events webhook configuration for the current account/environment.

// Request body only
await pingram.webhooks.upsertEventsWebhook({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

Parameters

Request Body Properties