Skip to main content

Webhooks for points and vouchers

See here for general information on setting up webhooks in Engage, and also which webhooks exist.

There are three webhooks available for syncing of points and vouchers in Engage:

  • loyalty.addPoints - Triggered when points are added to a contact via the Engage UI or through an automation. The transaction is sent in the webhook. This is only for customers using the point follower solution.

  • point.balance.updated - Triggered whenever a contact's point balance is changed.

  • reward.voucher.created - Triggered when a new reward voucher is created for a contact.

Example payload for loyalty.addPoints

{
  "eventType": String,
  "id": String,
  "isEncrypted": Boolean,
  "payload": : {
    "amount": Decimal,
    "contactId": String,
    "pointDefinitionId": Int,
    "source": String,
    "description": String,
    "userId": String,
    "userName": String,
    "reason": String,
    "sourceId": String,
  },
  "tenant": String
}

Example payload for point.balance.updated

{
  "eventType": String,
  "id": String,
  "isEncrypted": Boolean,
  "payload": : {
    "balance": Decimal,
    "contactId": String,
    "accountId": Int,
    "definitionId": String,
    "balanceExpires": DateTimeOffset
  },
  "tenant": String
}

Example payload for reward.voucher.created

{
  "eventId": String,
  "eventType": String,
  "isEncrypted": Boolean,
  "payload": {
    "Amount": Decimal,
    "ContactId": String,
    "Currency": String,
    "Id": String,
    "UniqueCode": String,
    "ValidFrom": DateTimeOffset,
    "ValidTo": DateTimeOffset
  },
  "tenant": String
}

Webhooks legal requirements

When you are implementing webhooks in Engage and move to a production environment, you'll need to approve Svix (Voyado's webhooks provider) as a GDPR sub-processor.