Skip to main content

Webhook

Rewards webhooks notify you when any new data is available after a successful rewards fetch.

These webhooks fire only after a completed rewards fetch. Actions performed on the member through other endpoints will not trigger the webhook.

FieldData TypeDefinition
actionStringThe action that triggered the webhook, e.g., member_data_updated.
completed_at IntegerThe time at which the aggregation that triggered the webhook was finished. Given in Unix epoch time.
completed_onStringThe date on which the aggregation that triggered the webhook was finished. Given in ISO 8601 without a timestamp.
member_guidStringThe unique identifier for the member which has new or updated data. Defined by MX.
rewards_created_countIntegerThe number of newly created rewards.
rewards_updated_countIntegerThe number of updated rewards.
typeStringThe type of webhook being delivered. Current possible values are AGGREGATION, HISTORY, REWARD, and STATEMENT; however, additional values may be added at any time.
user_guidStringUnique identifier for the user with which the data is associated. Defined by MX.

_10
{
_10
"action": "member_data_updated",
_10
"completed_at": 1531947410,
_10
"completed_on": "2018-07-18",
_10
"member_guid": "MBR-48d9a481-f2a2-7e13-2685-62869cf0d33a",
_10
"rewards_created_count": 3,
_10
"rewards_updated_count": 2,
_10
"type": "REWARD",
_10
"user_guid": "USR-eaf4ac68-d17d-5e9b-7b46-959a5b315a9e"
_10
}