What Triggers a Webhook

In this section, you will learn about webhook trigger actions.

In this section, you can review the actions that trigger specific webhooks. This will help you choose the best options for your marketing automation.

Webhook Name
Trigger Actions

TransactionRegistered

Transaction registered when creating transactions:

PointsWillExpire

Webhook is triggered X days before the units expire depending on the setup in the Expiring Notifications -> Expiring units notifications.

LevelWillExpire

Webhook is triggered X days before the tier recalculation depending on the setup in the Expiring Notifications -> Tier recalculation notification

AvailablePointsAmountChanged

  • When units are spent (reward purchase with points, or by using the https://apidocs.openloyalty.io/#tag/Points/operation/pointsPostTransferSpend endpoint)

  • When units are added or deducted manually by an admin

  • When a campaign adds or deducts units

  • Importing unit transfers

  • When pending units get activated (either automatically, or manually by the admin)

  • When units expire (either automatically, or manually by the admin)

  • When units are blocked ( https://apidocs.openloyalty.io/#tag/Points/operation/pointsPostTransferBlock )

  • When units are unblocked ( /api/:storeCode/points/:transfer/cancel )

  • When units are transferred between members (2 webhooks are sent - one for the receiver, and one for the sender)

TransactionAssignedToCustomer

RewardRedemptionStatusChanged

CampaignEffectWasApplied

The member receives points/ rewards or member custom attributes from the campaign. Example flow here.

CustomerWasRegisteredWithoutActivation

Member created without activation using the endpoint: POST/api/{storeCode}/member/register

CustomerUpdated

  • Adding/updating member basic information:

    • first and last name

    • phone number

    • email

    • loyalty card number

    • gender

    • registration date

    • birthday date

    • tier

The above actions can be taken in the Admin Panel or via API.

CustomerRequestedSendActivationCode

POST/api/{storeCode}/member/resend-code

CustomerRequestedPasswordReset

An active member who has been created within the endpoint: POST/api/{storeCode}/member/register requests a password reset using POST/api/{storeCode}/member/password/reset/reque

CustomerRegistered

CustomerPhoneNumberWasChanged

  • Logged member updates phone number on their profile.

CustomerLevelChanged

  • Manually changing a tier on a member profile (lower and higher)

  • While reaching the threshold of tier from conditions of the tier set

  • While creating a new member when the lowest tier is automatically assigned

The above actions can be taken in the Admin Panel or via API.

CustomerEmailWasChanged

  • Logged member updates an email on their profile.

CustomerDeactivated

CustomerBoughtReward

The above actions can be taken in the Admin Panel or via API.

CouponWillExpire

  • Webhook is triggered X days before the reward coupon expires depending on the setup in the Expiring Notifications -> Expiring coupons notifications.

Last updated

Was this helpful?