Organisation notifications with an agent

Use these tools for notices shared with an organisation. In every argument, clientId means the organisation id.

Before you start

Resolve the organisation with find_client_by_name or list_clients. The notification id is its sKey.

Call order

1. Call list_client_notifications with clientId.
2. Call get_client_notification with clientId and notificationId.
3. Call acknowledge_client_notification with clientId, notificationId, and required boolean isRead.

Example

{
  "clientId": "organisation-id",
  "notificationId": "notification-sKey",
  "isRead": true
}

Acknowledging marks the notice read for the caller. It does not delete the notice or the event that produced it.

Next