Event Bundles
Event Bundles allow you to group required actions that your clients have been requested to perform.
As actions are completed the case reply to email address(es) will be notified the same as if the actions were not bundled, however the email will contain a summary of what is still outstanding in the bundle.
Once all actions are completed for the bundle, the bundle recipients will be notified of the bundle completion with an email that contains all completed actions.
Event bundles must contain at least one action.
Event Bundling Actions
It is possible to group the following client requested actions into an "Event Bundle":
A Document has been signed
A Questionnaire has been completed
An ID Check has been completed
A Payment has been authorised
Event Bundle Explanation
An event bundle is identified by an identifier that you provide, your identifier is just a plain string and can be anything such as "Welcome Pack" or "Contract Pack".
An event bundle may contain zero or multiple recipients that you would like to be notified when the bundle has been completed.
An event bundle may have zero or multiple reminders that will be scheduled to be sent to the client(s) whilst the bundle is still outstanding.
Integrations
Depending on how you have integrated, there are different ways to provide the identifier, recipients and reminders that make up an event bundle, which you provide when you are creating the actionable item(s) for your client(s).
Email Parameters
With email integration you can use the following parameters:
Parameter | Type | Repeatable | Description |
|---|---|---|---|
bundleIdentifier | String | No | The bundle identifier, if it has been provided before and is not completed then it will use the existing bundle, if not it will create a new bundle with this identifier |
bundleRecipients | Email Address(es) | Comma Separated | The bundle recipients, a comma separated list of email addresses who will receive a notification when the event bundle has been completed |
bundleReminder | Reminder String | Yes | A bundle reminder, to be sent when the event bundle has not been completed, please refer to the below documentation for it's syntax |
Email Bundle Reminder Syntax
The email bundle reminder format allows you to configure a reminder for outstanding items within a bundle. The format of the reminder string is pipe separated and like this:
This is an example reminder that will schedule a reminder as follows:
has the identifier: "initial-reminder"
3 days and 2 hours after the first action of the bundle was sent to the client
has the author: "John Smith"
has the title: "Outstanding Items"
has the message: "Please review the outstanding items in your todo list, we are still awaiting you to complete these items so that we may progress your transaction" :
SOAP Parameters
With email integration you can use the following parameters:
Parameter | Type | Repeatable | Description |
|---|---|---|---|
bundleIdentifier | String | No | The bundle identifier, if it has been provided before and is not completed then it will use the existing bundle, if not it will create a new bundle with this identifier |
bundleRecipients | Email Address(es) | Comma Separated | The bundle recipients, a comma separated list of email addresses who will receive a notification when the event bundle has been completed |
bundleReminder | Reminder String | Yes | A bundle reminder, to be sent when the event bundle has not been completed, please refer to the below documentation for it's syntax |
SOAP Bundle Reminder Syntax
The email bundle reminder format allows you to configure a reminder for outstanding items within a bundle. The format of the reminder string is pipe separated and like this:
This is an example reminder that will schedule a reminder as follows:
has the identifier: "initial-reminder"
3 days and 2 hours after the first action of the bundle was sent to the client
has the author: "John Smith"
has the title: "Outstanding Items"
has the message: "Please review the outstanding items in your todo list, we are still awaiting you to complete these items so that we may progress your transaction" :
Email and SOAP Reminder Parameter Definition
Item | Type | Required | Explanation |
|---|---|---|---|
Identifier | String | Yes | Setting an identifier means that if you send the case tag information more than once, any existing reminders will be overwritten rather than added |
Schedule for | Period String or Date Time | Yes | How long after the action has been sent to the client should the reminder be sent, accepts "integer field" syntax where field can be week(s), day(s), hour(s), minute(s) or it can accept a custom date time format of year-month-day hour:minute where each field is full length and the hours are 24 hours e.g. 2026-01-01 14:08 |
Title | String | Yes | The author of the reminder message that is sent |
Title | String | Yes | The title of the reminder message that is sent |
Message | String | Yes | The message of the reminder message that is sent |
REST Parameters
The REST integration allows you to provide an EventBundle object that contains the following:
Parameter | Type | Description |
|---|---|---|
identifier | String | The bundle identifier, if it has been provided before and is not completed then it will use the existing bundle, if not it will create a new bundle with this identifier |
recipients | Array of Email Addresses | The bundle recipients, an array of email addresses who will receive a notification when the event bundle has been completed |
reminders | Array of EventBundleReminder | The bundle reminders, an array of Event Bundle Reminders to be sent when the event bundle has not been completed, please refer to the below documentation for it's syntax |
REST Event Bundle Reminder
The Event Bundle Reminder consists of the following fields:
Field | Type | Required | Explanation |
|---|---|---|---|
identifier | String | Yes | Setting an identifier means that if you send the case tag information more than once, any existing reminders will be overwritten rather than added |
scheduleFor | Period String or Date Time | Yes | How long after the action has been sent to the client should the reminder be sent, accepts "integer field" syntax where field can be week(s), day(s), hour(s), minute(s) or it can accept a custom date time format of year-month-day hour:minute where each field is full length and the hours are 24 hours e.g. 2026-01-01 14:08 |
author | String | Yes | The author of the reminder message that is sent |
title | String | Yes | The title of the reminder message that is sent |
message | String | Yes | The message of the reminder message that is sent |
Example REST Event Bundle JSON
You would provide this when sending a document, sending a questionnaire, sending an ID Check or requesting a payment to be made.
Event Bundle Use Cases
I would like the client to complete the client information questionnaire, and sign the terms and conditions document when signing up at the beginning of the transaction
I would like to have the identity check sent to a central department when it has been completed
I would like to request the client to make a payment on account and schedule reminders for them if they haven't done this after 3 days, 1 week and 2 weeks