Amazon Kinesis

Connect Pendula to Amazon Kinesis to stream real-time activity data into your own infrastructure, or trigger flows from incoming Kinesis streams.

Trigger flows from inbound Kinesis events

Use the Amazon Kinesis trigger node to start Pendula flows when events arrive in a Kinesis stream.

How to

Amazon Kinesis Trigger Node

What is the Amazon Kinesis Trigger node?

This node allows you to initiate a flow via the Kinesis stream. It transmits data (aka 'payload') from the Amazon Kinesis data stream into your flow.

To configure a trigger node, follow the steps below:

1. Click and drag the Amazon Kinesis Trigger node from the toolbar onto the canvas.

2. Select an integration from the drop-down menu.

3. Input stream name that will trigger the flow. This is the name of your stream in AWS console.

Stream name and Region on your Pendula tenant and AWS console must be identical so Pendula can 'listen' for the correct stream and trigger the flow.

4. Click Save.

In order to use the fields of the Payload object within a flow, go into the Advanced tab and copy the Node output key.

Learn more about using merge fields here.

View articles

Activity Sync: Stream flow activity out of Pendula

Use Activity Sync to emit real-time events from flows into your AWS stack for reporting, automation, and monitoring.

Concept

Activity Sync for Kinesis

Activity Sync allows you to stream experience and event data from your Pendula tenant to an Amazon Kinesis data stream, which can then be stored in an S3 bucket for reporting or analytics.

Need help with the full AWS setup? Follow our complete guide for configuring Amazon Kinesis and S3 before using these options in Pendula.

AWS access key ID

The AWS access key ID is used to authenticate your Amazon Kinesis connection. It identifies the IAM user that Pendula will use to send data to your Kinesis data stream.

The access key ID works together with the AWS secret access key to securely connect your Pendula tenant to Amazon Kinesis.

Important: The IAM user must have permissions to write to your Kinesis data stream. See our full setup guide for the required policy.

AWS secret access key

The AWS secret access key works with your access key ID to securely authenticate your Amazon Kinesis connection.

This value acts like a password — it should be stored securely and never shared. You will need both the access key ID and secret access key to set up your connection in Pendula.

Important: Pendula cannot retrieve this key once saved. If you lose it, a new access key must be created in your AWS account.

Stream name

Enter the name of your Amazon Kinesis data stream. This should match the name you configured in your AWS account.
The stream must already exist and be accessible with the credentials provided.

Stream region

Select the AWS region where your Kinesis data stream is hosted.
This ensures Pendula sends data to the correct AWS region.

Enabled state (on)

When Activity Sync is on, Pendula will stream selected experience and event data to your configured Kinesis stream.
The toggle will appear active, and additional fields (stream name and region) will be required.

Disabled state (off)

When Activity Sync is disabled, no event data will be streamed to your Kinesis stream.
You can enable Activity Sync at any time by toggling the option on and providing the required details. The Kinesis stream only emits events when it is turned on (events are not queued while a sync is turned off).

Paused or Errored state

If Pendula detects an issue with your Activity Sync configuration, you may see an error status on the connection.

In this case:

Review your stream name, region, and credentials
Use the Retry connection option to attempt re-establishing the connection

Upgrading your Activity Sync version

When a new version of Activity Sync is available:

Manage the connection you want to upgrade
Click the 'Configure' button next to the version
Select the version from the dropdown
New versions may introduce additional events

Always review the Activity Sync event documentation for details about new versions and compatibility as, once the connection saved, the version will be immediately upgraded.

How to

How to set up Activity Sync for Kinesis: from Pendula to an AWS S3 bucket

Activity Sync provides a range of information about the performance of messages as they pass through your Pendula tenant. This information can be streamed to external systems for analytics and reporting by connecting to the activity sync stream.

This guide walks through:

Creating an Amazon Kinesis data stream and connecting it to an S3 bucket using Firehose.
Setting up credentials and permissions in AWS.
Creating and configuring a connection in the Pendula interface to stream data with Activity Sync.

Prerequisites

You will need:

For AWS setup:

Administrator access to your AWS account.
Amazon Kinesis integration enabled in your Pendula tenant.

Step 1: Create the Kinesis data stream in AWS

Log into your AWS account using an Administrator role.
Open the AWS Management Console.
Search for Kinesis and select Kinesis – Work with Real-Time Streaming Data.
Click Create data stream.
Enter a Data stream name.
Note: This name will be used in Pendula’s connection setup.
Click Create data stream.
Once the stream is created, copy the ARN for reference in the next step.

Step 2: Set up IAM permissions

In AWS Console, go to IAM.
Click Policies, then Create policy.
Select the JSON tab and paste the following:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "PendulaAccess",
      "Effect": "Allow",
      "Action": [
        "kinesis:GetRecords",
        "kinesis:GetShardIterator",
        "kinesis:ListShards",
        "kinesis:PutRecord",
        "kinesis:PutRecords"
      ],
      "Resource": "Paste ARN Here"
    }
  ]
}

Replace "Paste ARN Here" with the ARN of your stream (created in the previous step).
Click Next.
Enter a Policy name and optional description.
Click Create policy.

Step 3: Create an IAM user and credentials

Go to IAM Users, then click Create user.
Enter a User name, click Next.
Select Attach policies directly and choose the policy created in the previous step.
Click Next, then Create user.
Select the new user, then click Create access key.
Choose Third-party service as the use case.
Confirm, add a description, and click Create access key.
Copy and save the access key ID and secret access key.
These credentials will be used in Pendula to create a connection.

Step 4: Create an S3 bucket to receive records

Go to S3 in AWS.
Click Create bucket.
Enter a Bucket name and adjust settings as needed.
Click Create bucket.

Step 5: Create the Firehose delivery stream

Search for and select Amazon Data Firehose.
Click Create Firehose stream.
Set the source to Amazon Kinesis Data Streams.
Set the destination to Amazon S3.
Choose your stream and S3 bucket from the Browse menus.
Click Create Firehose stream.

Step 6: Set up the Pendula connection and Activity Sync

Log into your Pendula tenant and go to the Integrations Hub.
Click Amazon Kinesis to add or configure a connection.
Enter:
- Name
- Description (optional)
- AWS access key ID and Secret access key

Under Stream data with Activity Sync:
- Toggle ON to enable Activity Sync
- Enter the raw Stream name (Not the entire ARN, just e.g. my-stream-name)
- Select the Region from the dropdown

Click Configure to customise event types to stream (optional):
- All events are selected by default
- Version is set to v1.0

Click Save connection or Update connection.

A toast will confirm the connection (including Activity Sync) is active.

Only use the stream name — do not enter the full ARN.

Step 7: Confirm data is arriving

Trigger a message or flow from your Pendula tenant.
Check your S3 bucket for new records.

Firehose buffering can cause delays of several minutes before data appears in S3.

If no data appears after 30 minutes, check CloudWatch metrics or log a Pendula support ticket.

Reference

Activity Sync (for Kinesis) events (v1.0)

Activity Sync (for Kinesis) streams real-time events from your flows and experiences into your own infrastructure.

v1.0 introduces a standardised structure across all event types, with versioning support, consistent data formatting, and clear separation of metadata, PII, and custom context.

This document details the v1.0 Activity Sync events, their structure, some sample payloads and key fields.

What's new in v1.0

Standardised schema with versioning (version: "1.0")
Tenant scoping via tenantId
Unified data block across all events
PII tagging for easier redaction and audit compliance
New event types including action, message-link-clicked, outbound-sms, and outbound-email
Deprecated v0.0 fields and kinds (e.g., queued, sent-to-gateway, outcome.success)

Event structure

Every Activity Sync event in v1.0 follows this structure:

{
  "version": "1.0",
  "timestamp": "ISO-8601 timestamp",
  "tenantId": "your-tenant-id",
  "workflowContext": {
    "experienceContext": { ... },
    "flowContext": { ... },
    "nodeContext": { ... }
  },
  "customContext": {},
  "kind": "event-type",
  "data": { ... },
  "pii": [ "fields" ]
}

Workflow context

All events include the same workflowContext block, which describes where in the flow the event occurred. It contains: experienceContext (the ID of the experience the event occurred for), flowContext (the ID, name, and version of the flow where the event occurred), and nodeContext (the identifying details of the node where the event occurred).

"workflowContext": {
  "experienceContext": {
    "experienceId": "501b95b3-06d3-4398-9ad4-b2563e158308"
  },
  "flowContext": {
    "flowId": "b07a5e44-04e3-4698-a799-04c558b77147",
    "flowName": "My first flow",
    "flowVersion": 2
  },
  "nodeContext": {
    "nodeId": "node-e72ur",
    "nodeName": "",
    "outputName": "conversation_2"
  }
}

nodeName is not populated yet.

This block is replaced with { ... } in examples below for brevity.

Key fields explained

version: Indicates the schema version for this event payload.
timestamp: Time the event occurred, formatted in ISO-8601.
tenantId: ID of the tenant generating the event.
workflowContext: Context from the triggering flow, including experience, flow, and node metadata.
customContext: Optional user-defined metadata (e.g. values passed in via merge fields).
kind: The type of event (e.g. experience-start, outbound-email).
data: The body of the event, with event-specific values (e.g. recipient, messageId).
pii: Array of keys from data or metadata that are considered personally identifiable information.
metadata (optional): Additional system context, used in some event types instead of workflowContext.

Workflow Studio events

Summary: An experience triggered.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "experience-start",
    "data": {},
    "pii": []
}

Summary: An experience successfully finished.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "experience-complete",
    "data": {
        "endPoint": "The value of the flow End point reached."
    },
    "pii": []
}

Summary: An experience failed.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "experience-failed",
    "data": {},
    "pii": []
}

Summary: An action ran.

Sample payload (with usage):

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "action",
    "data": {
        "actionId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "name": "package/outputName",
        "outcome": "success",
        "outcomeReason": "Details of the successful outcome.",
        "usage": [
            {
                "uom": "measurable-quantity",
                "qty": 3
            },
            {
                "uom": "another-measurable-quantity",
                "qty": 3
            }
        ]
    },
    "pii": [
        "outcomeReason"
    ]
}

Engagement Hub events

Summary: An SMS was queued for sending.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "outbound-sms",
    "data": {
        "usage": [
            {
                "uom": "sms-segments-au",
                "qty": 3
            }
        ],
        "recipient": "+61412345678",
        "body": "Thanks for signing up, John.",
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd"
    },
    "pii": [
        "body",
        "recipient"
    ]
}

Summary: An email was queued for sending.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "outbound-email",
    "data": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "usage": [
            {
                "uom": "email-recipients",
                "qty": 3
            }
        ],
        "from": "company@appleseed.com",
        "replyTo": "company@appleseed.com",
        "to": "john.smith@appleseed.com",
        "cc": [],
        "bcc": [],
        "subject": "Thanks for registering with us.",
        "body": "\n\n Hello world!\n \n",
        "plainTextBody": "\\n \\n Hello world!\\n \\n",
        "attachments": [
            {
                "filename": "welcomepack.pdf"
            },
            {
                "filename": "file2.png"
            }
        ]
    }
}

Summary: A message was sent.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "message-sent",
    "data": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "detail": "smtp: 225 Queued for delivery"
    },
    "pii": [
        "detail"
    ]
}

Summary: A message was delivered.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "message-delivered",
    "data": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "detail": "Delivered message"
    },
    "pii": [
        "detail"
    ]
}

Summary: A message failed to queue or send.

Sample payload:

{
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "message-failed",
    "data": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "detail": "Failed message"
    },
    "pii": [
        "detail"
    ]
}

Summary: A message was opened or read.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "message-opened",
    "data": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "detail": ""
    },
    "pii": [
        "detail"
    ]
}

Summary: A link within a message was clicked.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "message-link-clicked",
    "data": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "detail": ""
    },
    "pii": [
        "detail"
    ]
}

Summary: An inbound SMS started an experience.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "inbound-sms-matched",
    "metadata": {
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "matchedType": "Rule Match (Conversation)"
    },
    "data": {
        "sender": "+61487654321",
        "body": "I need some help",
        "matchedIntentKey": "upgrade",
        "matchedPart": "upgrade",
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
        "matchedType": "Rule Match (Conversation)"
    },
    "pii": [
        "sender",
        "body",
        "matchedIntentKey",
        "matchedPart"
    ]
}

Summary: An unmatched SMS was received.

Sample payload:

{
    "version": "1.0",
    "timestamp": "2024-08-27T13:25:04.913Z",
    "tenantId": "foo",
    "workflowContext": { ... },
    "customContext": {},
    "kind": "inbound-sms-unmatched",
    "data": {
        "sender": "+61487654321",
        "body": "I need some help",
        "messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd"
    },
    "pii": [
        "sender",
        "body"
    ]
}

Reference

Activity Sync (for Kinesis) events (v0.0)

Concept: Activity
Concept: Activity Sync

What this document covers:

What are the types of activity: Learn about the various types of activities that Pendula emits, including messaging, experience lifecycle activity, and inbound message matching.
How activities are structured: Each activity is provided in a structured JSON format, which includes contextual data like the flow, experience, and additional custom information.
How to use these activities: These activities can be consumed by third-party systems for monitoring, reporting, or alerting purposes. By understanding the structure of each activity, you can create meaningful insights or automate actions based on them.

Workflow context

For every activity, there is what’s called workflowContext (object). The workflowContext object contains all the relevant contextual information for that activity:

The associated experience (experienceContext: experienceID)
The associated flow (flowContext: flowId, flowName, flowVersion)
The associated node within the flow (nodeContext: nodeId, nodeName, outputName)

While all activities include workflowContext, some are not fully populated yet (Inbound message unmatched, inbound message trigger). We are working to implement workflowContext consistently for all activities.

"workflowContext": {
"experienceContext": {
"experienceId": "501b95b3-06d3-4398-9ad4-b2563e158308"
},
"flowContext": {
"flowId": "b07a5e44-04e3-4698-a799-04c558b77147",
"flowName": "My first flow",
"flowVersion": 2
},
"nodeContext": {
"nodeId": "node-e72ur",
"nodeName": "Upsell Conversation",
"outputName": "conversation_2"
}

Custom context

Custom context consists of a set of configurable key-value pairs that can be added to all activities for experiences. To learn more about custom context in depth and how to use it, please visit this article.

Experience activity

experience-start

The very first activity for an experience is an experience-start activity:

{
"experienceId": "60b34d82-7781-474b-ad10-4bca1a774e14",
"timestamp": "2024-08-27T13:25:04.913Z",
"workflowContext": {...},
"customContext": {},
"kind": "experience-start"
}

experience-finish (outcome: success, End point configured)

Here is a successful, ‘Complete’ experience-finish activity. This particular example shows an experience that reached a configured End point named converted.

When an experience finishes at a named End point, the value field is populated with the configured End point value:

{
"experienceId": "60b34d82-7781-474b-ad10-4bca1a774e14",
"timestamp": "2024-08-28T13:40:13.482Z",
"outcome": {
"success": {
"value": "converted"
}
},
"workflowContext": {...},
"customContext": {},
"kind": "experience-finish"
}

For more on how End points work and how values are used in flow reporting, see Flow performance reporting with End points.

experience-finish (outcome: failure)

Here is a failed, ‘Failed’ experience-finish activity. Before this activity, there may be other activities signalling what caused the experience to fail and finish (for instance, validation-failed for a message or bounce)

{
"experienceId": "60b34d82-7781-474b-ad10-4bca1a774e14",
"timestamp": "2024-08-28T14:12:52.134Z",
"outcome": {
"failure": {
"errorMessage": "Unhandled outcome for messaging/sendSenderIdSmsWithOutcome: failure/validation-error. Context: {\\"rawArgs\\":{\\"message\\":{\\"kind\\":\\"handlebars\\",\\"handlebars\\":\\"Activity Sync - Unmatched Trigger node - SENT outcome\\"},\\"senderId\\":{\\"kind\\":\\"handlebars\\",\\"handlebars\\":\\"PENDULA_TEST\\"},\\"recipientNumber\\":{\\"kind\\":\\"handlebars\\",\\"handlebars\\":\\"{{ unmatchedMessageTrigger_1.fromNumber }}\\"},\\"successTimeoutMins\\":{\\"kind\\":\\"number\\",\\"number\\":1}},\\"outputs\\":{\\"outcome\\":\\"failure\\",\\"outcomeReason\\":\\"validation-error\\",\\"timestamp\\":1724854371406},\\"args\\":{\\"message\\":\\"Activity Sync - Unmatched Trigger node - SENT outcome\\",\\"senderId\\":\\"PENDULA_TEST\\",\\"recipientNumber\\":\\"+61401260405\\",\\"successTimeoutMins\\":1},\\"type\\":\\"messaging/sendSenderIdSmsWithOutcome\\",\\"nodeId\\":\\"node-g2zkv\\"}",
"errorCode": "experiences/fail"
}
},
"workflowContext": {...},
"customContext": {},
"kind": "experience-finish"
}

experience-failed

And finally, here is an ‘Error’ experience-failed activity. If multiple of these activities are detected within a flow; the flow itself will be stopped and also set to status ‘Error’.

{
"experienceId": "ee4ee007-2bb2-41de-8da3-038cfe33564d",
"timestamp": "2024-09-04T00:05:23.443Z",
"workflowContext": {...},
"customContext": {},
"errorDetails": [
{
"errorMessage": "Not found: inboundWebhookTrigger_1 (full path: inboundWebhookTrigger_1.message). Available fields were: AvailableFields[inboundSMSTrigger_1.fromNumber:<+.10.5>,inboundSMSTrigger_1.matchedIntent:<m.8.d>,inboundSMSTrigger_1.matchedPart:<M.8.d>,inboundSMSTrigger_1.matchedType:<E.19.)>,inboundSMSTrigger_1.messageBody:<M.8.d>,inboundSMSTrigger_1.timestamp:<number>]",
"errorCode": null
}
],
"kind": "experience-failed"
}

Messaging events

A message being ‘queued’ is the first activity in the process of sending a message. The message queued activity contains all of the relevant information for the lifecycle of a message (recipient, message body, attachments etc) and generates a message ID.

Any subsequent activities (sent to gateway, delivered, opened, any failures etc) can all be correlated back to the initial queued activity using the message ID.

queued (SMS)

Here is a message queued activity for an SMS:

{
"messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
"payload": {
"sender": "0000000000",
"recipient": "+61412345678",
"body": "Thanks for signing up, John.",
"segmentCount": 1,
"kind": "sms"
},
"timestamp": "2024-08-28T13:38:46.210055990Z",
"workflowContext": {...},
"customContext": {},
"kind": "queued"
}

queued (email)

Here is a message queued activity for an email:

{
  "messageId": "3064433f-d939-4df9-b49b-a2fa2573bce2",
  "payload": {
    "sender": "me@appleseed.com",
    "recipient": "john.smith@bananas.com",
    "subject": "Thanks for registering with us.",
    "body": "<hmtl>\\n <body>\\n Hello world!\\n </body>\\n</hmtl>",
    "plainTextBody": "\\n \\n Hello world!\\n \\n",
    "replyTo": "me@appleseed.com",
    "attachments": [
      {
        "filename": "welcomepack.pdf"
      },
      {
        "filename": "file2.png"
      }
    ],
    "kind": "email"
  },
  "timestamp": "2024-08-29T01:18:25.532229654Z",
  "workflowContext": {...},
  "customContext": {},
  "kind": "queued"
}

sent-to-gateway

Here is a message sent to gateway activity for SMS and email:

{
"messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
"timestamp": "2024-08-28T13:38:46.434638837Z",
"workflowContext": {...},
"customContext": {},
"kind": "sent-to-gateway"
}

delivered

Here is a message delivered activity for SMS and email:

{
"messageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
"timestamp": "2024-08-28T13:38:52.362Z",
"workflowContext": {...},
"customContext": {},
"kind": "delivered"
}

opened

Here is a message opened activity for SMS and email:

{
"messageId": "3064433f-d939-4df9-b49b-a2fa2573bce2",
"timestamp": "2024-08-29T01:19:41.746Z",
"workflowContext": {...},
"customContext": {},
"kind": "opened"
}

bounced

Here is a message bounced activity for SMS and email:

{
"messageId": "ad45e9e3-e0ae-48f9-bdc0-e7c328a10b0b",
"errors": [
{
"errorMessage": "Bad request",
"errorCode": "explanation"
}
],
"timestamp": "2024-08-28T14:01:52.132Z",
"workflowContext": {...},
"customContext": {},
"kind": "bounced"
}

validation-failed

Here is an activity for when a message fails to send due to validation failing:

{
"messageId": "fb1ec07a-42ae-4b90-ae02-5b6cc8f6a2e3",
"errors": [
{
"errorMessage": "NonEmptyList(Recipient must be a valid phone number, got: Beepboop. )",
"errorCode": null
}
],
"timestamp": "2024-09-03T04:29:45.419079448Z",
"workflowContext": {...},
"customContext": {},
"kind": "validation-failed"
}

rejected-by-gateway

{
"messageId": "fb1ec07a-42ae-4b90-ae02-5b6cc8f6a2e3",
"errors": [
{
"errorMessage": "Rejected by gateway.",
"errorCode": null
}
],
"timestamp": "2024-09-03T04:29:45.419079448Z",
"workflowContext": {...},
"customContext": {},
"kind": "rejected-by-gateway"
}

Inbound messages & replies

inbound-matched-intent (trigger)

Here is a message inbound matched trigger activity (this happens after an experience-start activity):

Note that workflowContext is not fully populated: flowName and flowVersion

{
"messageId": "d3703474-8c92-4ee8-acf0-5353407bbc71",
"parentMessageId": "1d8e4e9c-69d8-4cd1-83fe-c13ef6870cfd",
"matchedIntentKey": "optin",
"matchedType": "Rule Match (Trigger)",
"matchedPart": "opt-in",
"body": "I'd like to opt-in",
"fromNumber": "+61412345678",
"timestamp": "2024-09-03T03:48:49.187411Z",
"workflowContext": {
"experienceContext": {
"experienceId": "6c36658f-6017-449e-9f91-3f23e3e9876a"
},
"flowContext": {
"flowId": "7d39b190-71fd-4295-9a48-1285f083de95",
"flowName": "?",
"flowVersion": 0
},
"nodeContext": {...}
},
"flowId": "7d39b190-71fd-4295-9a48-1285f083de95",
"customContext": {},
"kind": "inbound-matched-intent"
}

inbound-matched-intent (reply)

Here is a reply:

{
"messageId": "5ae77323-c8c5-4858-ac35-27798e98d6e9",
"parentMessageId": "e5cebadf-f1bc-4c2b-b892-f7ddd1bb3e59",
"matchedIntentKey": "upgrade",
"matchedType": "Rule Match (Conversation)",
"matchedPart": "upgrade",
"body": "I'd like to upgrade",
"fromNumber": "+61412345678",
"timestamp": "2024-09-03T04:27:52.953530Z",
"workflowContext": {...},
"flowId": "7d39b190-71fd-4295-9a48-1285f083de95",
"customContext": {},
"kind": "inbound-matched-intent"
}

inbound-unmatched

Here is a message inbound unmatched activity (this happens after an experience-start event):

Note that workflowContext is not fully populated: flowID, flowName and flowVersion

{
"messageId": "e46a9bce-f03e-4232-b68c-f27fce70a99f",
"payload": {
"sender": "+61487654321",
"recipient": "+61412345678",
"body": "I need some help",
"kind": "sms"
},
"timestamp": "2024-08-29T01:18:24.792807Z",
"workflowContext": {
"experienceContext": {
"experienceId": "60b34d82-7781-474b-ad10-4bca1a774e14"
},
"flowContext": {
"flowId": "?",
"flowName": "?",
"flowVersion": 0
},
"nodeContext": {...}
},
"customContext": {},
"kind": "inbound-unmatched"
}

View articles

Trigger flows from inbound Kinesis events

Amazon Kinesis Trigger Node

What is the Amazon Kinesis Trigger node?

Activity Sync: Stream flow activity out of Pendula

Activity Sync for Kinesis

AWS access key ID

AWS secret access key

Stream name

Stream region

Enabled state (on)

Disabled state (off)

Paused or Errored state

Upgrading your Activity Sync version

How to set up Activity Sync for Kinesis: from Pendula to an AWS S3 bucket

Prerequisites

For AWS setup:

Step 1: Create the Kinesis data stream in AWS

Step 2: Set up IAM permissions

Step 3: Create an IAM user and credentials

Step 4: Create an S3 bucket to receive records

Step 5: Create the Firehose delivery stream

Step 6: Set up the Pendula connection and Activity Sync

Step 7: Confirm data is arriving

Activity Sync (for Kinesis) events (v1.0)

What's new in v1.0

Event structure

Workflow context

Key fields explained

Workflow Studio events

Engagement Hub events

Activity Sync (for Kinesis) events (v0.0)

What this document covers:

Workflow context

Custom context

Experience activity

experience-start

experience-finish (outcome: success, End point configured)

experience-finish (outcome: failure)

experience-failed

Messaging events

queued (SMS)

queued (email)

sent-to-gateway

delivered

opened

bounced

validation-failed

rejected-by-gateway

Inbound messages & replies

inbound-matched-intent (trigger)

inbound-matched-intent (reply)

inbound-unmatched

<%= section.name %>

In this article

<%= heading %>