Events and payload
The webhook payload contains a data model specific to the event type. The table below provides information about each data model you can expect, as well as when a particular event would be triggered.
Most events use existing data models as described in the data dictionary. Rather than duplicating documentation, each event type links to the relevant data model in the data dictionary.
info
The webhooks payload only contains the top level and nested shared data models. Nested top level data models are not returned to maintain performance. For example, the Activity will not contain the full Point, Behaviour, Reward or Tag objects. The IDs of the nested top level data models can be used to retrieve the data from the APIs where required.
| Event | Description | Data model |
|---|---|---|
| Ping | Triggered whenever a new webhook is created and used to check whether your endpoint is correctly receiving requests from Mambo. Can also be triggered manually from the list of webhooks. | {"message":"ping"} |
| ActivityCreated | Triggered when an activity is created. | Activity |
| ActivityBehavioursAdded | Triggered when the behaviours associated to an activity have been processed and their respective statuses added to the activity. | Activity |
| ActivityAwardedAdded | Triggered when any reward or KPI associated to an activity is processed and added to the activity. There may be rewards which unlock other rewards or KPIs, meaning you may receive multiple webhook requests sent to your endpoint. | Activity |
| ActivityExpiredPointsDebited | Triggered when points in an activity are expired. | Activity |
| ActivityRejected | Triggered when an activity is rejected. | Activity |
| NotificationCreated | Triggered when a new notification is created. | Notification |
| NotificationRead | Triggered when an existing notification is marked as read. Note that this event is only fired when individual notifications are marked as read. The event will not be fired when notifications are marked as read in bulk, for example, when you clear all a user's notifications. | Notification |
| PointCreated | Triggered when a new point is created. | Point |
| PointUpdated | Triggered when an existing point is updated. | Point |
| BehaviourCreated | Triggered when a new behaviour is created. | Behaviour |
| BehaviourUpdated | Triggered when an existing behaviour is updated. | Behaviour |
| RewardCreated | Triggered when a new reward is created. | Reward |
| RewardUpdated | Triggered when an existing reward is updated. | Reward |
| KPICreated | Triggered when a new KPI is created. | KPI |
| KPIUpdated | Triggered when an existing KPI is updated. | KPI |
| LeaderboardCreated | Triggered when a new leaderboard is created. | Leaderboard |
| LeaderboardUpdated | Triggered when an existing leaderboard is updated. | Leaderboard |
| LeaderboardRankingUpdated | Triggered when a leaderboard is ranked. | Leaderboard |
| CouponCreated | Triggered when a new coupon is created. | Coupon |
| CouponUpdated | Triggered when an existing coupon is updated. | Coupon |
| CouponStateAdded | Triggered when a coupon is awarded to a user. | Coupon State |
| TagCreated | Triggered when a new tag is created. | Tag |
| TagUpdated | Triggered when an existing tag is updated. | Tag |
| UserCreated | Triggered when a new user is created. | User |
| UserUpdated | Triggered when an existing user is updated. | User |
| UserMemberJoined | Triggered when a user isMember property is set to true and the user joins the gamification strategy. | User |
| UserMemberLeft | Triggered when a user isMember property is set to false and the user leaves the gamification strategy. | User |