Rupert provides an API that allows you to access raw engagement data for each workflow you've sent. This gives you a granular view of how recipients interact with your workflows—empowering you to perform deeper internal analysis and reporting.
🛠️ Note: The data returned by the API is raw. The data shown in the Workflow Manager is a formatted version of this raw data for easier viewing. Use the API to work with the underlying events and signals directly.
💬 What is Engagement Data?
Engagement data reflects how recipients interacted with each workflow delivery. It includes events such as:
Clicking action buttons
Reacting with emojis
Replying to messages
Viewing or opening a message
Gainsight and Salesforce actions
Other signals of interaction and attention
This data is essential for understanding the impact and reach of your workflows.
🔍 What Can I Do with This Data?
You can use engagement data to:
Track performance of specific workflows
Build internal dashboards or trend analyses
Generate reports for stakeholders or clients
Compare engagement across different segments
Feed into machine learning models or scoring systems
🔗 What Types of Queries Can I Run?
Using the API, you can retrieve raw engagement data at the delivery level for a specific workflow run. The key parameters are:
alert_id – the identifier for the workflow
run_ts – the timestamp for the workflow run
delivery_id – the recipient-specific delivery instance
Each query returns data for a specific recipient's interaction with a specific workflow delivery. This includes a detailed breakdown of the engagement events tied to that delivery.
You can find technical details and the available parameters in our API documentation.
🔐 How to Get Access
To use the API, you’ll need an API key. Please contact our support team and we’ll provide access credentials and onboarding help to get you started.