Integration Hub
The Integration Hub provides integrations for specific use cases, for example, issuing a coupon when a customer reaches a new loyalty tier.
These integrations are designed to be simple to set up and use, without needing to write any code.
To access the Integration Hub, open > Integrations > Generic integrations.
Integrations and instances
In the context of the Integration Hub, the following terms are used:
- An integration is a workflow template including the logic, inputs, and connections for a specific task.
- An instance is a deployment of an integration running with a specific set of configuration values.
You can create multiple instances from the same integration. While the name of an integration is fixed, you can give each instance a custom name to help you identify it.
Example:
- Integration: Trigger Rule Engine: Tier upgrade
- Instance 1 name:
Tier upgrade - VIP program - Instance 2 name:
Tier upgrade - Rewards program
- Instance 1 name:
In this setup, both instances use the same Trigger Rule Engine: Tier upgrade integration, but each instance is configured for a different loyalty program.
Updates to an integration are released as new versions, while previous versions remain available for use.
When you create a new instance, it uses the latest version and stays on that version even if newer ones are released. You can manually update individual instances to benefit from improvements and new features.
Available integrations
Currently, only one integration is available in the Integration Hub. More integrations will be added in the future.
Trigger Rule Engine: Tier upgradeClosed beta
Allows you to trigger the Rule Engine when a loyalty tier upgrade happens. When a customer reaches a new tier, the integration sends a custom event that the Rule Engine evaluates, letting you trigger effects.
See the tutorial on how to set up this integration and use it.
Common use cases include:
- Issue a welcome coupon: Create a coupon code for the customer to use on their next purchase.
- Add loyalty points: Award bonus loyalty points as a reward for reaching the new tier.
- Add the customer to an audience: Automatically enroll the customer in a tier-specific audience to unlock targeted campaigns.
- Send a notification: Trigger a webhook to notify an external system, for example, to send a congratulatory email or update a CRM record.
Available event attributes
When configuring the integration, you can choose which attributes to include in the custom event sent to the Rule Engine. The custom event can include the following attributes:
| Attribute name | Description | Type | Nullable |
|---|---|---|---|
CurrentPoints | Number of points the customer had at the time of tier upgrade. | Number | No |
CurrentTier | Name of the customer's current loyalty tier. | String | Yes |
LoyaltyProgramID | ID of the loyalty program. | Number | No |
NextTier | Name of the customer's next higher loyalty tier. Returns null if the customer has reached the highest available tier. Returns the lowest level tier name if the customer is not currently assigned to any tier. | String | Yes |
OldTier | Name of the customer's previous loyalty tier. | String | Yes |
PointsRequiredToTheNextTier | Number of points required to reach the next tier. | Number | Yes |
ProfileIntegrationID | Integration ID of the customer profile whose tier was upgraded. | String | No |
PublishedAt | Timestamp when the notification was published. | Time | No |
SourceOfEvent | Source that triggered the tier change event. | String | No |
SubledgerID | ID of the loyalty subledger. | String | No |
TierExpirationDate | Timestamp when the current tier expires. | Time | Yes |
TimestampOfTierChange | Timestamp when the tier change happened. | Time | Yes |