capabilities.work

Topic Broadcast Campaign

A 3-step recipe with Novu. We can help you get access.

Recipe · 3 steps

Topic Broadcast Campaign

with Novu

Upsert a topic, add subscribers, then trigger one notification to the topic.

  1. Create the topic if it does not exist, or update its name if it does. Novu returns 200 on update and 201 on first creation.
  2. Subscribe the supplied subscriber ids to the topic. If the topic does not yet exist it will be created by this call.
  3. Trigger the named workflow addressed to the whole topic so every current subscriber of the topic receives the notification.
What you'll need to have ready
  • topicKey: The unique key identifier for the topic (e.g. "product-updates").
  • topicName: Display name for the topic.
  • subscriberIds: List of subscriber ids to subscribe to the topic.
  • workflowId: The trigger identifier of the workflow to broadcast to the topic.
  • payload: Custom payload object used to render the workflow.
For your developer

Arazzo workflow novu:topic-broadcast-campaign, 3 operations: TopicsController_upsertTopic → TopicsController_createTopicSubscriptions → EventsController_trigger. Specs on APIs.io.

More recipes with Novu

Bulk Onboard Subscribers and Broadcast an AnnouncementCreate a Workflow and Trigger ItOffboard a SubscriberOnboard a Subscriber and Send Their First NotificationProvision a Delivery Integration and Make It PrimarySet Subscriber Preferences Then NotifySubscribe an Existing Subscriber to a TopicSubscriber Inbox TriageTrigger a Notification and Verify DeliveryTrigger a Deferred Notification and Cancel It