Send Notification

Beta

POST/v1/messaging/notifications

Idempotent with Idempotency-Key header. Learn more

Sends an in-app notification to a single user or broadcasts it to every user in an account.

Delivery is asynchronous: the notification is fanned out to its recipients and pushed to connected clients in real time.

Permissions requiredValues:alerts:create

The role behind your API key or agent must grant every one of these permissions.

categorystringenumValues:chat.messagechat.mentionchat.added

Category of the notification.

targetobject

Who to send to: an account_user for a per-user notification, or an account to broadcast an announcement to every user in it.

typestringenumValues:account_useraccount

The kind of target.

idstring

The id of the target (an account_user id or an account id, matching type).

titlestring

Human-readable title.

bodyoptional string

Preview/body text.

priorityoptional stringenumValues:lownormalhigh

Delivery priority. Defaults to normal.

link_resource_typeoptional stringenumValues:accountactorentity

Object type of the resource this notification should link to.

Set together with link_resource_id to point the notification at something the recipient can open.

link_resource_idoptional string

ID of the resource this notification should link to.

objectstringenumValues:notification_send_result

Resource type identifier.

enqueuedinteger

Number of recipients the notification was enqueued for.

Responses

202

Successful response for Send Notification

Send Notification

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const notificationSendResult = await client.messaging.notifications.create({
  category: 'order.updated',
  target: { type: 'account_user', id: 'acus_01ea9983ddb41dacc44ecf997c' },
  title: 'Order updated',
});

console.log(notificationSendResult.enqueued);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const notificationSendResult = await client.messaging.notifications.create({
  category: 'order.updated',
  target: { type: 'account_user', id: 'acus_01ea9983ddb41dacc44ecf997c' },
  title: 'Order updated',
});

console.log(notificationSendResult.enqueued);

202 example

{
  "object": "notification_send_result",
  "enqueued": 1
}

{
  "object": "notification_send_result",
  "enqueued": 1
}

Send Notification

Authorization

Request Body

Returns

Responses