Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

User Status Notification

The User Status Notification is a structured message format that facilitates the real-time communication of user status updates within an omni-channel campaign. It includes essential details like user and campaign identification, status information, and context, enabling systems and applications to respond appropriately to the user's progress or changes in status.

Values

Key

Type

Description

type

string

The type of notificaiton.

Payload Data

user_id

integer

This represents a unique identifier for the user whose status is being updated.

campaign_id

integer

This is an identifier for the campaign in which the user is participating. It associates the status update with a particular campaign, allowing for organized tracking.

status_id

integer

An identifier associated with the status update itself.

status

string

A descriptive string that indicates the current status of the user within the campaign. This could be a status such as "active," "completed," "paused," or any other relevant status.

break_name

string

This field is used to provide additional context or information about the user's status, especially if the status is related to a break or interruption in their participation.

  • No labels