Skip to main content

Topics

Topics enable pub/sub-style fan-out delivery.

Create a Topic​

POST /api/v1/notifications/manage/create-topic
{
  "topicKey": "weekly-updates",
  "name": "Weekly Updates"
}

Add/Remove Subscribers​

POST /api/v1/notifications/manage/add-subscribers-to-topic
{
  "topicKey": "weekly-updates",
  "userIds": ["user-1", "user-2"]
}

Up to 100 subscribers per call.

POST /api/v1/notifications/manage/remove-subscribers-from-topic
{
  "topicKey": "weekly-updates",
  "userIds": ["user-1"]
}

Send to Topic​

POST /api/v1/notifications/manage/send-to-topic
{
  "workflowId": "push-notification",
  "topicKey": "weekly-updates",
  "payload": {
    "title": "Weekly Update",
    "body": "Your weekly health summary is ready"
  },
  "excludeUserId": "user-admin"
}

List Topic Subscribers​

POST /api/v1/notifications/manage/list-topic-subscribers
{
  "topicKey": "weekly-updates",
  "page": 1,
  "pageSize": 50
}

Check Subscription​

POST /api/v1/notifications/manage/check-topic-subscription
{
  "topicKey": "weekly-updates",
  "userId": "user-1"
}