Skip to main content
Notifications

Send Notification

Sends a new notification to one or more users(recipients).

POST
/
v3
/
notifications

Authentication Parameters

X-ENGAGESPOT-API-KEY
string
header
required

Your Engagespot app's api key which can be found in your console.

X-ENGAGESPOT-API-SECRET
string
header
required

Your Engagespot app's api secret which can be found in your console.

Body Parameters

notification
object
required

sendTo
object
required

data
object

Additional payload data

sendAt
string

The time should be in ISO 8601 format example - 2024-07-02T09:24:10.000Z.

override
object

Override delivery preferences configured in your account.

Response

requestId
string

The id of this request. You can use this ID to track this request from Engagespot logs.

import { EngagespotClient } from '@engagespot/node';

const client = EngagespotClient({
  apiKey: 'ENGAGESPOT_API_KEY',
  apiSecret: 'ENGAGESPOT_API_SECRET',
});

client.send({
  notification: {
    title: 'Agent X commented on your support ticket #T-793465',
  },
  sendTo: {
    recipients: ['unique-id-of-user'],
  },
});
{
  "requestId": "du472-6547-4547-4547-4547"
}