Server SDKs (Back-end)

The server-side SDKs allow you to trigger sending notifications, setting user preferences and more. Supported environments:

• Node.js official
• Python official
• PHP official
• Laravel official
• Go official
• C# official
• Ruby documented
• Any environment that supports HTTP calls

If you don't see your language/framework documented here, just ping us on support and we will provide samples and docs.

Setup & Initialization

Node

1. Install using one of the following package managers:

npm install notificationapi-node-server-sdk

yarn add notificationapi-node-server-sdk

pnpm add notificationapi-node-server-sdk

2. Import:

import notificationapi from 'notificationapi-node-server-sdk';
// or using require:
// const notificationapi = require('notificationapi-node-server-sdk').default;

3. Initialize:

notificationapi.init('CLIENT_ID', 'CLIENT_SECRET');

Python

1. Install Package:

pip install notificationapi_python_server_sdk

2. Import:

from notificationapi_python_server_sdk import (notificationapi)

3. Initialize:

notificationapi.init("CLIENT_ID", "CLIENT_SECRET")

PHP

1. Install Package:

composer require notificationapi/notificationapi-php-server-sdk

2. Import:

use NotificationAPI\NotificationAPI;

3. Initialize:

$notificationapi = new NotificationAPI('CLIENT_ID', 'CLIENT_SECRET');

Laravel

1. Install Package:

composer require notificationapi/notificationapi-laravel-server-sdk:@dev

info

If your composer.json's "minimum-stability" field is "stable", then you may need to run composer require notificationapi/notificationapi-php-server-sdk:@dev to ensure that the notificationapi-laravel-server-sdk package has its dependencies installed as well.

Alternatively you can update "minimum-stability" to "dev" instead of explicitely installing notificationapi-php-server-sdk:@dev.

2. Register the NotificationApiServiceProvider with config/app.php:

'providers' => [
	// ...
	NotificationAPI\NotificationApiServiceProvider::class,
]

3. Add NotificationAPI keys to .env:

NOTIFICATION_API_KEY=clientID
NOTIFICATION_API_SECRET=clientSecret

4. Generate Notification:

php artisan make:notification MyNotification

5. Update the Notification class:

class MyNotification extends Notification
{
    // ...

    public function via($notifiable)
    {
        return ['notification-api'];
    }

    public function toNotificationApi($notifiable)
    {
        return [
            "notificationId" => "my_notification_id",
            "user" => [
                "id" => $notifiable->getAttribute('id'),
                "email" => $notifiable->getAttribute('email'),
            ],
            "mergeTags" => [
                "userName" => auth()->user()->name
            ]
        ];
    }
}

Go

1. Install Package:

go get github.com/notificationapi-com/notificationapi-go-server-sdk

2. Import:

import (
  notificationapi "github.com/notificationapi-com/notificationapi-go-server-sdk"
)

3. Initialize:

notificationapi.Init("CLIENT_ID", "CLIENT_SECRET")

C#

1. Install Package:

dotnet add package NotificationAPI --version 0.1.0

2. Import:

using NotificationApi.Server;
using NotificationApi.Server.Models;

3. Initialize:

var notificationApi = new NotificationApiServer("CLIENT_ID", "CLIENT_SECRET", false);

Ruby

1. Copy the following class to your application:

require 'net/http'
require 'json'
require 'base64'
require 'openssl'

class NotificationAPI
  def initialize(client_id, client_secret)
    @base_url = 'https://api.notificationapi.com'
    @client_id = client_id
    @auth_token = Base64.strict_encode64("#{client_id}:#{client_secret}")
    @http_client = Net::HTTP.new('api.notificationapi.com', 443)
    @http_client.use_ssl = true
  end

  def send(request)
    payload = request.to_json
    response = @http_client.post(
      "/#{@client_id}/sender",
      payload,
      {
        'Content-Type' => 'application/json',
        'Authorization' => "Basic #{@auth_token}"
      }
    )
    response.body
  end

  def retract(request)
    payload = request.to_json
    response = @http_client.post(
      "/#{@client_id}/sender/retract",
      payload,
      {
        'Content-Type' => 'application/json',
        'Authorization' => "Basic #{@auth_token}"
      }
    )
    response.body
  end

  def identify_user(user_id, user_data)
    digest = OpenSSL::Digest::SHA256.new
    hmac = OpenSSL::HMAC.digest(digest, @client_secret, user_id)
    hashed_user_id = Base64.strict_encode64(hmac)
    custom_auth = Base64.strict_encode64("#{@client_id}:#{user_id}:#{hashed_user_id}")

    send_request('POST', "users/#{URI.escape(user_id)}", user_data, custom_auth)
  end

  def create_sub_notification(notification_id, sub_notification_id, title)
    payload = { title: title }
    send_request('PUT', "notifications/#{notification_id}/subNotifications/#{sub_notification_id}", payload)
  end

  def delete_sub_notification(notification_id, sub_notification_id)
    send_request('DELETE', "notifications/#{notification_id}/subNotifications/#{sub_notification_id}")
  end

  def update_schedule(tracking_id, scheduleUpdate)
    send_request('PATCH', "notifications/#{tracking_id}", scheduleUpdate)
  end

  def delete_schedule(tracking_id)
    send_request('DELETE', "notifications/#{tracking_id}")
  end

  def set_user_preferences(user_id, user_preferences)
    send_request('POST', "user_preferences/#{user_id}", user_preferences)
  end

  private

  def send_request(method, uri, data = {}, auth = "Basic #{@auth_token}")
    payload = data.to_json
    response = @http_client.send_request(
      method,
      "/#{@client_id}/#{uri}",
      payload,
      {
        'Content-Type' => 'application/json',
        'Authorization' => auth
      }
    )
    response.body
  end

end

2. Initialize:

notificationapi = NotificationAPI.new("CLIENT_ID", "CLIENT_SECRET")

Name	Type	Description
CLIENT_ID*	string	Your NotificationAPI account clientId. You can get it from here.
CLIENT_SECRET*	string	Your NotificationAPI account client secret. You can get it from here.
options	object	Additional initialization
options.baseUrl	string	To choose a different region than default (US). Use https://api.ca.notificationapi.com to access the Canada region.

* required

send

Used to send a notification to the specified user.

Node

notificationapi.send({
  notificationId: 'order_tracking',
  user: {
    id: 'spongebob.squarepants',
    email: 'spongebob@squarepants.com',
    number: '+15005550006'
  },
  mergeTags: {
    item: 'Krabby Patty Burger',
    address: '124 Conch Street',
    orderId: '1234567890'
  }
});

Python

import asyncio

async def send_notification():
    await notificationapi.send(
        {
            "notificationId": "order_tracking",
            "user": {
                "id": "spongebob.squarepants",
                "email": "spongebob@squarepants.com",
                "number": "+15005550006",
            },
            "mergeTags": {
                "item": "Krabby Patty Burger",
                "address": "124 Conch Street",
                "orderId": "1234567890"
            }
        }
    )

# Run the async function
asyncio.run(send_notification())

PHP

$notificationapi->send([
    "notificationId" => "order_tracking",
    "user" => [
        "id" => "spongebob.squarepants",
        "email" => "spongebob@squarepants.com",
        "number" => "+15005550006"
    ],
  "mergeTags" => [
    "item" => "Krabby Patty Burger",
    "address" => "124 Conch Street",
    "orderId" => "1234567890"
  ]
]);

Laravel

The notificationapi-laravel-server-sdk package uses Laravel's notifications.

<?php

use App\Models\User;
use App\Notifications\MyNotification;

$user = new User();
$user->name = 'John Doe';
$user->id = 'john.doe@example.com';
$user->email = 'john.doe@example.com';

// Send the notification to the user
$user->notify(new MyNotification($user));

info

Alternatively you can send a notification without using Laravel's notifications:

$data = [
  "notificationId" => "my_notification_id",
  "user" => [
      "id" => "user_id",
      "email" => "john.doe@example.com",
  ],
  "mergeTags" => [
      "userName" => "user_name"
  ]
];

$result = notification_api($data);
#or
$result = (new NotificationApiService)->send($data)

Go

mergeTags := make(map[string]interface{}) // Change to map[string]interface{}
mergeTags["item"] = "Krabby Patty Burger"
mergeTags["address"] = "124 Conch Street"
mergeTags["orderId"] = "1234567890"

notificationapi.Send(
  notificationapi.SendRequest{
    NotificationId: "order_tracking",
    User: notificationapi.User{
      Id:     "test_user_id",
      Email:  "spongebob@squarepants.com",
    },
    MergeTags: mergeTags,
  },
)

C#

var user = new NotificationUser("spongebob.squarepants")
{
    Email = "spongebob@squarepants.com",
    TelephoneNumber = "+15005550006"
};

var mergeTags = new Dictionary<string, object>
{
    { "item", "Krabby Patty Burger" },
    { "address", "124 Conch Street" },
    { "orderId", "1234567890" }
};

await notificationApi.Send(new SendNotificationData("curl_test", user)
{
    MergeTags = mergeTags
});

Ruby

notificationapi.send({
  notificationId: 'order_tracking',
  user: {
    id: 'spongebob.squarepants',
    email: 'spongebob@squarepants.com',
    number: '+15005550006'
  },
  mergeTags: {
    item: 'Krabby Patty Burger',
    address: '124 Conch Street',
    orderId: '1234567890'
  }
});

Parameters

The send() method accepts an object with the following fields:

Name	Type	Description
notificationId*	string	The ID of the notification you wish to send. You can find this value from the dashboard.
user*	object	The user to send the notification to.
user.id*	string	The ID of the user in your system. Required. This is the only user field required for sending in-app, web push, and mobile push notifications.
user.email	string	Required for sending email notifications, otherwise optional.
user.number	string	Required for SMS/CALL notifications, otherwise optional. Valid format: +15005550006. Unformatted US/Canada numbers are also accepted, e.g., (415) 555-1212, 415-555-1212, or 4155551212.
user.timezone	string	The user's timezone. Timezone names correspond to the Zone and Link names of the IANA Time Zone Database, such as 'America/New_York', 'America/Denver', 'EST', and 'UTC'.
mergeTags	object	Used to pass in dynamic values into the notification design. Read more: Dynamic Parameters (Merge Tags)
schedule	string	An ISO 8601 datetime string to schedule the notification for. For example, 2024-02-20T14:38:03.509Z
replace	object, string key/value pair	Similar to mergeTags, but more flexible. Like the programmatic string replace function, this parameter will replace any string in the notification templates with another string. This operation happens on the fly when sending the notification and does not actually modify the templates. This operation is case-sensitive and happens after mergeTags are injected.
subNotificationId	string	To break down your notification into multiple categories or groups. Read more: Sub Notifications
templateId	string	By default, notifications are sent using the default template of each channel. You can permanently change the default template from the dashboard. However, you can also use this parameter to force using a specific template. This is useful in multiple situations: - Design variation: using different wording and design, e.g. "You have new updates" vs. "You don't have any updates" - White-labeling: using a specific template that you designed for a white-labeled customer - Language: creating and using multiple templates for multiple languages If the provided templateId does not exist for a channel, the default template will be used, and a warning message will be generated.
forceChannels (deprecated)	string[]	Used to override the channels which are used for the notification. This field only overrides the notification's channels configuration. It does not override the user preferences. Values available for use are: EMAIL, INAPP_WEB, SMS, CALL, PUSH, WEB_PUSH E.g. forceChannels: ["EMAIL", "SMS"]
options	object	For configuring additional options

Options Object

Name	Type	Description
email	object	Email options features.
email.replyToAddresses	string[]	An array of email addresses to be used in the reply-to field of emails notifications.
email.ccAddresses	string[]	An array of emails to be CC'ed on the email notifications.
email.bccAddresses	string[]	An array of emails to be BCC'ed on the email notifications.
email.fromName	string	A string to display as the "From" field in an email
email.fromAddress	string	An email address to send the email from
email.attachments	{ filename: string; url: string }[]	An array of publicly accessible URLs and filenames pointing to files that you wish to include as attachments. The URLs only need to be valid for a few minutes after calling the SDK method. After that, the public URLs can be disabled for privacy. The maximum email size (including the content and all attachments) is 25MB. File extensions in the filename property are necessary for the file to show up nicely in the recipient's device.
apn	object	Additional Apple push notification
apn.expiry	number	The UNIX timestamp representing when the notification should expire. This does not contribute to the 2048 byte payload size limit. An expiry of 0 indicates that the notification expires immediately.
apn.priority	number	The priority of the notification. If you omit this header, APNs sets the notification priority to 10. Specify 10 to send the notification immediately. Specify 5 to send the notification based on power considerations on the user’s device. Specify 1 to prioritize the device’s power considerations over all other factors for delivery, and prevent awakening the device.
apn.collapseId	string	An identifier you use to merge multiple notifications into a single notification for the user. Typically, each notification request displays a new notification on the user’s device. When sending the same notification more than once, use the same value in this header to merge the requests. The value of this key must not exceed 64 bytes.
apn.threadId	string	Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together. For local notifications, this key corresponds to the threadIdentifier property of the UNNotificationContent object.
apn.badge	number	Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
apn.sound	string	Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s data container. If the sound file cannot be found, or if you specify default for the value, the system plays the default alert sound. For details about providing sound files for notifications; see here
apn.contentAvailable	boolean	Include this key with a value of 1 to configure a background update notification. When this key is present, the system wakes up your app in the background and delivers the notification to its app delegate. For information about configuring and handling background update notifications, see here
fcm	object	Additional Firebase Cloud Messaging push notification options
fcm.android	object	Additional Android push notification options
fcm.android.collapseKey	string	This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active. Note that there is no guarantee of the order in which messages get sent. Note: A maximum of 4 different collapse keys is allowed at any given time. This means a FCM connection server can simultaneously store 4 different send-to-sync messages per client app. If you exceed this number, there is no guarantee which 4 collapse keys the FCM connection server will keep.
fcm.android.priority	string	Sets the priority of the message. Valid values are "normal" and "high." On iOS, these correspond to APNs priorities 5 and 10. By default, notification messages are sent with high priority, and data messages are sent with normal priority. Normal priority optimizes the client app's battery consumption and should be used unless immediate delivery is required. For messages with normal priority, the app may receive the message with unspecified delay. When a message is sent with high priority, it is sent immediately, and the app can wake a sleeping device and open a network connection to your server.
fcm.android.ttl	string	This parameter specifies how long (in seconds) the message should be kept in FCM storage if the device is offline. The maximum time to live supported is 4 weeks, and the default value is 4 weeks. For more information, see Setting the lifespan of a message

identifyUser

Stores the end-user information for a given user.

By using this function, you can omit the contact information when using send(). NotificationAPI will automatically lookup the user's stored email or phone number and use it for sending the notification.

Node

notificationapi.identifyUser({
  id: 'spongebob.squarepants',
  email: 'spongebob@squarepants.com',
  number: '+15005550006',
  pushTokens: [
    {
      type: PushProviders.FCM,
      token: 'samplePushToken',
      device: {
        app_id: 'com.example.app',
        ad_id: '1234567890',
        device_id: '1234567890',
        platform: 'android',
        manufacturer: 'Samsung',
        model: 'SM-G930F'
      }
    }
  ],
  webPushTokens: [
    {
      sub: {
        endpoint:
          'https://fcm.googleapis.com/fcm/send/fCs_4iba0Ao:APA91bGFdaU7I3****JMH_KeZwk1Xi',
        keys: {
          p256dh:
            'zP2xFu3hMc2vNH5E2nuKkyjpZydvCk9llRUY2kP4****9aSlKcoadSV2UbvMRQ',
          auth: 'CXEFun************tYe8g'
        }
      }
    }
  ]
});

Python

import asyncio

async def identify_user():
    await notificationapi.identify_user({
        "id": "spongebob.squarepants",
        "email": "spongebob@squarepants.com",
        "number": "+15005550006",
        "pushTokens": [
            {
                "type": "FCM",
                "token": "samplePushToken",
                "device": {
                    "app_id": "com.example.app",
                    "ad_id": "1234567890",
                    "device_id": "1234567890",
                    "platform": "android",
                    "manufacturer": "Samsung",
                    "model": "SM-G930F"
                }
            }
        ],
        "webPushTokens": [
            {
                "sub": {
                    "endpoint": "https://fcm.googleapis.com/fcm/send/fCs_4iba0Ao:APA91bGFdaU7I3****JMH_KeZwk1Xi",
                    "keys": {
                        "p256dh": "zP2xFu3hMc2vNH5E2nuKkyjpZydvCk9llRUY2kP4****9aSlKcoadSV2UbvMRQ",
                        "auth": "CXEFun************tYe8g"
                    }
                }
            }
        ]
    })

# Run the async function
asyncio.run(identify_user())

PHP

$user = [
    'id' => 'spongebob.squarepants',
    'email' => 'spongebob@squarepants.com',
    'number' => '+15005550006',
    'pushTokens' => [
        [
            'type' => 'FCM',
            'token' => 'samplePushToken',
            'device' => [
                'app_id' => 'com.example.app',
                'ad_id' => '1234567890',
                'device_id' => '1234567890',
                'platform' => 'android',
                'manufacturer' => 'Samsung',
                'model' => 'SM-G930F'
            ]
        ]
    ],
    'webPushTokens' => [
        [
            'sub' => [
                'endpoint' => 'https://fcm.googleapis.com/fcm/send/fCs_4iba0Ao:APA91bGFdaU7I3****JMH_KeZwk1Xi',
                'keys' => [
                    'p256dh' => 'zP2xFu3hMc2vNH5E2nuKkyjpZydvCk9llRUY2kP4****9aSlKcoadSV2UbvMRQ',
                    'auth' => 'CXEFun************tYe8g'
                ]
            ]
        ]
    ]
];

$notificationAPI->identifyUser($user);

Go

number := "+15005550006"
user := NotificationAPI.User{
		Id:     "spongebob.squarepants",
		Email:  "spongebob@squarepants.com",
		Number: &number,
		PushTokens: &[]NotificationAPI.UserPushToken{
			{
				Type:  String("FCM"),
				Token: String("samplePushToken"),
				Device: &NotificationAPI.UserPushTokenDevice{
					App_id:        String("com.example.app"),
					Ad_id:         String("1234567890"),
					Device_id:     String("1234567890"),
					Platform:      String("android"),
					Manufacturer:  String("Samsung"),
					Model:         String("SM-G930F"),
				},
			},
		},
		WebPushTokens: &[]NotificationAPI.UserWebPushToken{
			{
				Sub: struct {
					Endpoint string `json:"endpoint,omitempty"`
					Keys     struct {
						P256DH string `json:"p256dh,omitempty"`
						Auth   string `json:"auth,omitempty"`
					} `json:"keys,omitempty"`
				}{
					Endpoint: "https://fcm.googleapis.com/fcm/send/fCs_4iba0Ao:APA91bGFdaU7I3****JMH_KeZwk1Xi",
					Keys: struct {
						P256DH string `json:"p256dh,omitempty"`
						Auth   string `json:"auth,omitempty"`
					}{
						P256DH: "zP2xFu3hMc2vNH5E2nuKkyjpZydvCk9llRUY2kP4****9aSlKcoadSV2UbvMRQ",
						Auth:   "CXEFun************tYe8g",
					},
				},
			},
		},
	}
var params notificationapi.SetUserPreferencesRequest
NotificationAPI.IdentifyUser(user)

C#

var userId = "spongebob.squarepants";

await notificationApi.Identify(userId, new IdentifyUserData()
{
    Email = "spongebob.squarepants",
    TelephoneNumber = "+15005550006"
});

Ruby

user_id = "spongebob.squarepants"
user_data = {
  email: "spongebob@squarepants.com",
  number: "+15005550006",
  pushTokens: [
    {
      type: PushProviders::FCM, # Assuming PushProviders::FCM is defined
      token: "samplePushToken",
      device: {
        app_id: "com.example.app",
        ad_id: "1234567890",
        device_id: "1234567890",
        platform: "android",
        manufacturer: "Samsung",
        model: "SM-G930F"
      }
    }
  ],
  webPushTokens: [
    {
      sub: {
        endpoint: "https://fcm.googleapis.com/fcm/send/fCs_4iba0Ao:APA91bGFdaU7I3****JMH_KeZwk1Xi",
        keys: {
          p256dh: "zP2xFu3hMc2vNH5E2nuKkyjpZydvCk9llRUY2kP4****9aSlKcoadSV2UbvMRQ",
          auth: "CXEFun************tYe8g"
        }
      }
    }
  ]
}

notification_api.identify_user(user_id, user_data)

Parameters

Name	Type	Description
id*	string	The ID of the user in your system. Required.
email	string	Required for sending email notifications, otherwise optional.
number	string	Required for SMS/CALL notifications, otherwise optional. Valid format: +15005550006. Unformatted US/Canada numbers are also accepted, e.g., (415) 555-1212, 415-555-1212, or 4155551212.
timezone	string	The user's timezone. Timezone names correspond to the Zone and Link names of the IANA Time Zone Database, such as 'America/New_York', 'America/Denver', 'EST', and 'UTC'.
pushTokens	object[]	Tokens which are required to send mobile push notifications, a user can have multiple devices and a push token is required for each device.
webPushTokens	object[]	Tokens which are required to send web push notification, a user can have multiple devices and a web push token is required for each device.

pushTokens object

Name	Type	Description
type*	string	[apn,fcm] The provider token is to be associated with. Required.
token*	string	The full token string. Required.
device*	object	Information about the device the token is associated with. Required.

device object

Name	Type	Description
app_id	string	Id of the application the token is used for.
ad_id	string	Id of the advertising identifier.
device*	string	Id of the device the token is associated with. Required.
platform	string	The device platform i.e. android, ios.
manufacturer	string	The device manufacturer.
model	string	The device model .

webPushTokens object

Name	Type	Description
sub*	object	Web push subscription. Required.

Web push subscription (sub) object

Name	Type	Description
endpoint*	string	The string value containing the endpoint associated with the push subscription. Required.
keys*	object	The keys associated with the push subscription. Required.

Web push subscription keys object

Name	Type	Description
p256dh*	string	An Elliptic curve Diffie–Hellman public key on the P-256 curve (that is, the NIST secp256r1 elliptic curve). The resulting key is an uncompressed point in ANSI X9.62 format. Required.
auth*	string	An authentication secret, as described in Message Encryption for Web Push. Required.

setUserPreferences

Used to set a user's notification preferences. This function will override the user's existing preferences.

Node

notificationapi.setUserPreferences('userId', [
  {
    notificationId: 'new_order',
    channel: 'INAPP_WEB',
    delivery: 'weekly'
  },
  {
    notificationId: 'order_tracking',
    channel: 'SMS',
    delivery: 'weekly'
  }
]);

Python

import asyncio

async def set_user_preferences():
    await notificationapi.setUserPreferences("userId", [
        {
            "notificationId": "new_order",
            "channel": "INAPP_WEB",
            "delivery": "weekly"
        },
        {
            "notificationId": "order_tracking",
            "channel": "SMS",
            "delivery": "weekly"
        }
    ])

# Run the async function
asyncio.run(set_user_preferences())

PHP

$notificationapi->setUserPreferences("userId", [
    [
        "notificationId" => "new_order",
        "channel" => "INAPP_WEB",
        "delivery" => "weekly"
    ],
    [
        "notificationId" => "order_tracking",
        "channel" => "SMS",
        "delivery" => "weekly"
    ]
]);

Go

jsonParams := `[
  {
    notificationId: "new_order",
    channel: "INAPP_WEB",
    delivery: "weekly"
  },
  {
    notificationId: "order_tracking",
    channel: "SMS",
    delivery: "weekly"
  }
]`
var params notificationapi.SetUserPreferencesRequest
json.Unmarshal([]byte(jsonParams), &params)
notificationapi.SetUserPreferences("userId", params)

C#

await notificationApi.SetUserPreferences(userId, new SetUserPreferencesData(){
    Preferences = [new NotificationPreference("order_tracking", NotificationChannel.EMAIL, true)]
});

Ruby

user_preferences = [
  { 'notificationId' => 'new_order', 'channel' => 'INAPP_WEB', 'delivery' => 'weekly'},
  { 'notificationId' => 'order_tracking', 'channel' => 'SMS', 'delivery' => 'weekly'}
]

notification_api.set_user_preferences('userId', user_preferences)

Parameters

Name	Type	Description
userId*	string	The ID of the user in your system. Required.
preferences*	object[]	An array of preference objects.

Preference Object

Name	Type	Description
notificationId*	string	The ID of the notification you wish to send. You can find this value from the dashboard.
channel	string	The channel you wish to set the preference for. Accepted values: EMAIL, INAPP_WEB, SMS, CALL, PUSH, WEB_PUSH
delivery	string	The method for delivering the notification. Accepted values: off, instant, hourly, daily, weekly, monthly

deleteUserPreferences

Used to delete any stored preferences for a user and notificationId or subNotificationId.

Node

notificationapi.deleteUserPreferences(
  'spongebob.squarepants',
  'order_tracking'
);

Python

import asyncio

async def delete_user_preferences():
    await notificationapi.deleteUserPreferences({"notificationId": "order_tracking", "userId": "spongebob.squarepants"})

# Run the async function
asyncio.run(delete_user_preferences())

PHP

$notificationapi->deleteUserPreferences(["notificationId" => "order_tracking", "userId" => "spongebob.squarepants"]);

Go

jsonParams := `{
  NotificationId: "order_tracking",
  UserId: "spongebob.squarepants"
}`
var params notificationapi.DeleteUserPreferencesRequest
json.Unmarshal([]byte(jsonParams), &params)
notificationapi.DeleteUserPreferences(params);

C#

await notificationApi.DeleteUserPreferences(new DeleteUserPreferencesData(){
    NotificationId = "order_tracking",
    UserId = "spongebob.squarepants"
});

Ruby

notificationapi.deleteUserPreferences({
  notificationId: 'order_tracking',
  userId: 'spongebob.squarepants'
});

Parameters

Name	Type	Description
userId*	string	The ID of the user in your system. Required.
notificationId*	string	The ID of the notification in NotificationAPI. Required.
subNotificationId	string	The subNotificationId is used to specify further subcategories within a notification.

updateInAppNotification

Used to update the opened, archived, ... of an inapp notification.

Node

notificationapi.deleteUserPreferences('spongebob.squarepants', {
  trackingIds: ['sampleTrackingId'],
  opened: '1970-01-01T00:00:00.000Z',
  clicked: '1970-01-01T00:00:00.000Z',
  archived: '1970-01-01T00:00:00.000Z',
  actioned1: '1970-01-01T00:00:00.000Z',
  actioned2: '1970-01-01T00:00:00.000Z',
  reply: { date: '1970-01-01T00:00:00.000Z', message: 'nice!' }
});

Python

import asyncio

async def delete_user_preferences():
    await notificationapi.delete_user_preferences("spongebob.squarepants", {
        "trackingIds": ["sampleTrackingId"],
        "opened": "1970-01-01T00:00:00.000Z",
        "clicked": "1970-01-01T00:00:00.000Z",
        "archived": "1970-01-01T00:00:00.000Z",
        "actioned1": "1970-01-01T00:00:00.000Z",
        "actioned2": "1970-01-01T00:00:00.000Z",
        "reply": {"date": "1970-01-01T00:00:00.000Z", "message": "nice!"}
    })

# Run the async function
asyncio.run(delete_user_preferences())

PHP

$notificationapi->delete_user_preferences("spongebob.squarepants", [
    "trackingIds" => ["sampleTrackingId"],
    "opened" => "1970-01-01T00:00:00.000Z",
    "clicked" => "1970-01-01T00:00:00.000Z",
    "archived" => "1970-01-01T00:00:00.000Z",
    "actioned1" => "1970-01-01T00:00:00.000Z",
    "actioned2" => "1970-01-01T00:00:00.000Z",
    "reply" => ["date" => "1970-01-01T00:00:00.000Z", "message" => "nice!"]
]);

Go

DeleteUserPreferences("spongebob.squarepants", map[string]interface{}{
	"trackingIds": []string{"sampleTrackingId"},
	"opened":      "1970-01-01T00:00:00.000Z",
	"clicked":     "1970-01-01T00:00:00.000Z",
	"archived":    "1970-01-01T00:00:00.000Z",
	"actioned1":   "1970-01-01T00:00:00.000Z",
	"actioned2":   "1970-01-01T00:00:00.000Z",
	"reply": map[string]interface{}{
		"date":    "1970-01-01T00:00:00.000Z",
		"message": "nice!",
	},
})

C#

await notificationApi.DeleteUserPreferences("spongebob.squarepants", new Dictionary<string, object>
{
    {"trackingIds", new string[] {"sampleTrackingId"}},
    {"opened", "1970-01-01T00:00:00.000Z"},
    {"clicked", "1970-01-01T00:00:00.000Z"},
    {"archived", "1970-01-01T00:00:00.000Z"},
    {"actioned1", "1970-01-01T00:00:00.000Z"},
    {"actioned2", "1970-01-01T00:00:00.000Z"},
    {"reply", new Dictionary<string, object>
        {
            {"date", "1970-01-01T00:00:00.000Z"},
            {"message", "nice!"}
        }
    }
});

Ruby

notificationapi.delete_user_preferences('spongebob.squarepants', {
  'trackingIds' => ['sampleTrackingId'],
  'opened' => '1970-01-01T00:00:00.000Z',
  'clicked' => '1970-01-01T00:00:00.000Z',
  'archived' => '1970-01-01T00:00:00.000Z',
  'actioned1' => '1970-01-01T00:00:00.000Z',
  'actioned2' => '1970-01-01T00:00:00.000Z',
  'reply' => { 'date' => '1970-01-01T00:00:00.000Z', 'message' => 'nice!' }
})

Parameters

Name	Type	Description
userId*	string	The ID of the user in your system. Required.
params*	string	The inapp notification data you want to update. Required.

params

Name	Type	Description
trackingIds*	string[]	The Tracking IDs of the notifications you want to update. Required.
opened	string	A string representing the time when the notification was opened. Optional.
clicked	string	A string representing the time when the notification was clicked. Optional.
archived	string	A string representing the time when the notification was archived. Optional.
actioned1	string	A string representing the time when the first action associated with the notification was taken. Optional.
actioned2	string	A string representing the time when the second action associated with the notification was taken. Optional.
reply.date	string	A string representing the time of the reply to the notification. Optional.
reply.message	string	A string representing the content of the reply message. Optional.

retract

Only applicable to in-app notifications. This function helps you delete all notifications of a certain type for a user.

Node

notificationapi.retract({
  notificationId: 'order_tracking',
  userId: 'spongebob.squarepants'
});

Python

import asyncio

async def retract_notification():
    await notificationapi.retract({"notificationId": "order_tracking", "userId": "spongebob.squarepants"})

# Run the async function
asyncio.run(retract_notification())

PHP

$notificationapi->retract(["notificationId" => "order_tracking", "userId" => "spongebob.squarepants"]);

Go

jsonParams := `{
  NotificationId: "order_tracking",
  UserId: "spongebob.squarepants"
}`
var params notificationapi.RetractRequest
json.Unmarshal([]byte(jsonParams), &params)
notificationapi.Retract(params);

C#

await notificationApi.Retract(new RetractNotificationData(){
    NotificationId = "order_tracking",
    UserId = "spongebob.squarepants"
});

Ruby

notificationapi.retract({
  notificationId: 'order_tracking',
  userId: 'spongebob.squarepants'
});

Name	Type	Description
notificationId*	string	The ID of the notification you wish to retract. You can find this value from the dashboard.
userId*	string	The ID of the user in your system. Required.
secondaryId	string	For when you want to delete a specific subNotificationId.

updateSchedule

This function enables you to update a scheduled notification by providing a trackingId.

Node

notificationapi.updateSchedule('172cf2f4-18cd-4f1f-b2ac-e50c7d71891c', {
  schedule: '2024-02-20T14:38:03.509Z'
});

Python

import asyncio

async def update_schedule():
    await notificationapi.update_schedule({
        "tracking_id": "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c",
        "send_request": {"schedule": "2024-02-20T14:38:03.509Z"}
    })

# Run the async function
asyncio.run(update_schedule())

PHP

$notificationapi->updateSchedule([
    "trackingId" => "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c",
    "sendRequest" => [
        "schedule" => "2024-02-20T14:38:03.509Z"
    ]
]);

Go

updateReq := NotificationAPI.UpdateScheduleRequest{
		Schedule: "2024-02-20T14:38:03.509Z",
	}
trackingId := "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"
notificationapi.UpdateSchedule(trackingId, updateReq)

C#

await notificationApi.UpdateSchedule("TRACKING_ID", new UpdateScheduleData(){
    Schedule = new DateTime()
});

Ruby

notificationapi.update_schedule(
  tracking_id: '172cf2f4-18cd-4f1f-b2ac-e50c7d71891c',
  {
		schedule: "2024-02-20T14:38:03.509Z",
	}
);

Name	Type	Description
trackingId*	string	The tracking ID of the scheduled notification you wish to update. You can find this value from the dashboard.

deleteSchedule

This function allows you to delete a scheduled notification by providing a trackingId.

Node

notificationapi.deleteSchedule('172cf2f4-18cd-4f1f-b2ac-e50c7d71891c');

Python

import asyncio

async def delete_schedule():
    await notificationapi.delete_schedule({
        "tracking_id": "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"
    })

# Run the async function
asyncio.run(delete_schedule())

PHP

$notificationapi->deleteSchedule([
    "trackingId" => "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"
]);

Go

 trackingId := "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"
 notificationapi.DeleteSchedule(trackingId)

C#

await notificationApi.DeleteSchedule("TRACKING_ID");

Ruby

notificationapi.delete_schedule('172cf2f4-18cd-4f1f-b2ac-e50c7d71891c');

Name	Type	Description
trackingId*	string	The tracking ID of the scheduled notification you wish to delete. You can find this value from the dashboard.

queryLogs

This function allows you to run queries on the logs of your send requests.

Node

notificationapi.queryLogs({
  dateRangeFilter: {
    startTime: 1719600830559;
    endTime: 1719600840559;
  },
  notificationFilter: ['order_tracking'],
  channelFilter: ['EMAIL'];
  userFilter: ['abcd-1234'],
  statusFilter: ['SUCCESS'],
  trackingIds: ['172cf2f4-18cd-4f1f-b2ac-e50c7d71891c'],
  requestFilter: ['request.mergeTags.item="Krabby Patty Burger"'],
  envIdFilter: ["6ok6imq9unr2budgiebjdaa6oi"]
});

Python

import asyncio

async def query_logs():
    await notificationapi.queryLogs({
        "dateRangeFilter": {
            "startTime": 1719600830559,
            "endTime": 1719600840559
        },
        "notificationFilter": ["order_tracking"],
        "channelFilter": ["EMAIL"],
        "userFilter": ["abcd-1234"],
        "statusFilter": ["SUCCESS"],
        "trackingIds": ["172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"],
        "requestFilter": ['request.mergeTags.item="Krabby Patty Burger"'],
        "envIdFilter": ["6ok6imq9unr2budgiebjdaa6oi"]
    })

# To run the async function
asyncio.run(query_logs())

PHP

$notificationapi->queryLogs([
    "dateRangeFilter" => [
        "startTime" => 1719600830559,
        "endTime" => 1719600840559,
    ],
    "notificationFilter" => ['order_tracking'],
    "channelFilter" => ['EMAIL'],
    "userFilter" => ['abcd-1234'],
    "statusFilter" => ['SUCCESS'],
    "trackingIds" => ['172cf2f4-18cd-4f1f-b2ac-e50c7d71891c'],
    "requestFilter" => ['request.mergeTags.item="Krabby Patty Burger"'],
    "envIdFilter" => ['6ok6imq9unr2budgiebjdaa6oi']
]);

Go

params := map[string]interface{}{
  "dateRangeFilter": map[string]interface{}{
    "startTime": 1719600830559,
    "endTime":   1719600840559,
  },
  "notificationFilter": []string{"order_tracking"},
  "channelFilter":      []string{"EMAIL"},
  "userFilter":         []string{"abcd-1234"},
  "statusFilter":       []string{"SUCCESS"},
  "trackingIds":        []string{"172cf2f4-18cd-4f1f-b2ac-e50c7d71891c"},
  "requestFilter":      []string{`request.mergeTags.item="Krabby Patty Burger"`},
  "envIdFilter":        []string{"6ok6imq9unr2budgiebjdaa6oi"},
}

notificationAPI.QueryLogs(params)

C#

var parameters = new Dictionary<string, object>
        {
            { "dateRangeFilter", new Dictionary<string, long> { { "startTime", 1719600830559 }, { "endTime", 1719600840559 } } },
            { "notificationFilter", new List<string> { "order_tracking" } },
            { "channelFilter", new List<string> { "EMAIL" } },
            { "userFilter", new List<string> { "abcd-1234" } },
            { "statusFilter", new List<string> { "SUCCESS" } },
            { "trackingIds", new List<string> { "172cf2f4-18cd-4f1f-b2ac-e50c7d71891c" } },
            { "requestFilter", new List<string> { @"request.mergeTags.item=""Krabby Patty Burger""" } },
            { "envIdFilter", new List<string> { "6ok6imq9unr2budgiebjdaa6oi" } }
        };

        await notificationApi.QueryLogs(parameters);

Ruby

params = {
  dateRangeFilter: {
    startTime: 1719600830559,
    endTime: 1719600840559
  },
  notificationFilter: ['order_tracking'],
  channelFilter: ['EMAIL'],
  userFilter: ['abcd-1234'],
  statusFilter: ['SUCCESS'],
  trackingIds: ['172cf2f4-18cd-4f1f-b2ac-e50c7d71891c'],
  requestFilter: ['request.mergeTags.item="Krabby Patty Burger"'],
  envIdFilter: ['6ok6imq9unr2budgiebjdaa6oi']
}

notificationapi.query_logs(params)

Name	Type	Description
dateRangeFilter	object	Filters logs by a specific date range. Optional.
dateRangeFilter.startTime	number	The start time of the date range filter as a Unix timestamp. Optional. Cannot be less than your log retention period.
dateRangeFilter.endTime	number	The end time of the date range filter as a Unix timestamp. Optional.
notificationFilter	string[]	Filters logs by specific notification IDs. Optional. This allows you to retrieve logs for particular notifications.
channelFilter	Channels[]	Filters logs by specific channels. Optional. This allows you to retrieve logs for certain channels like EMAIL, SMS, etc.
userFilter	string[]	Filters logs by specific user IDs. Optional. This allows you to retrieve logs for particular users.
statusFilter	string[]	Filters logs by specific statuses. Optional. This allows you to retrieve logs with particular statuses like sent, failed, etc.
trackingIds	string[]	Filters logs by specific tracking IDs. Optional. This allows you to retrieve logs for particular tracking events.
requestFilter	string[]	Filters logs by specific body request of your send request. Optional. This allows you to retrieve logs for particular requests.
envIdFilter	string[]	Filters logs by specific environment IDs. Optional. This allows you to retrieve logs for particular environments.
customFilter	string	A custom filter for querying logs. Optional. This allows for more advanced and flexible querying of logs. Note: custom filter overwrites all the filters.

You can run more complex filters using customFilter. Note that customFilter overwrites all other filters in the request.

customFilter

fields @message| filter request.user.email like /com/ and request.user.email not like /gmail.com/| sort @timestamp desc