Subscribe / Unsubscribe from Object

Subscribe users to or Unsubscribe users from Object

You can use this node to dynamically add in or remove recipient or actor from the object. This is one of the ways to update object subscription based on an event or action.

If you have event-based data coming from third-party systems, you don’t need to write custom object subscription APIs in your codebase. Simply send events to SuprSend, and let the workflow handle object subscriptions or user profile updates. For example, when someone subscribes to a topic (like a tournament), you can automatically add them as a subscriber to the corresponding object. This ensures they receive all relevant notifications about topic-related activities without manual intervention.


Creating objects dynamically within workflow

You can either add users to an existing object or create object on the fly using workflow input data. While defining object, both ID and type are mandatory. Type defines the group that object belong to (example, teams, departments). Dynamic object are defined in handlebars format as {{...}}.

Object will only be created if Create object if it doesn't exist setting is ON.

One common usecase of creating object dynamically is when you need to create different objects based on user topic subscription. For example, there are multiple player tournaments happening and you want to create a separate object for each tournament. Object ID in such case can be {{tournament_id}} and type tournaments.

🚧

Both object ID and type only supports following characters - `a-z,0-9,-,_`. Ensure that the variable resolves to a valid format; otherwise, object creation will fail.


Subscription Properties

Subscription properties define the specifics of the relationship between a subscriber and an object. During a workflow execution, these properties can be accessed under the recipient.subscription namespace as recipient.subscription.property_key. Subscription properties are added in JSONNET format. You can read more about object subscription here.