LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
    • Timezones
Powered by GitBook
On this page

Was this helpful?

  1. Main Features
  2. Webhooks

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:

  • in the UI

  • Transaction import

PointsWillExpire

LevelWillExpire

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

  • Matching transactions manually in the UI

  • Importing matches

RewardRedemptionStatusChanged

CampaignEffectWasApplied

CustomerWasRegisteredWithoutActivation

CustomerUpdated

  • Adding/updating member basic information:

    • first and last name

    • phone number

    • email

    • loyalty card number

    • gender

    • registration date

    • birthday date

    • tier

  • Adding/updating address/company details

  • Updating Agreements

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

CustomerRequestedSendActivationCode

  • Member requests resending the activation code using the endpoint:

CustomerRequestedPasswordReset

CustomerRegistered

  • Member created in the Admin panel

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

Last updated 3 months ago

Was this helpful?

via API:

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

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

When the unit transfer is cancelled ( )

Matching transaction via API:

Changing the status of the reward in the UI or via API:

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

Member created without activation using the endpoint:

Adding member custom attributes when editing a member in the Admin UI or API:

Member requests an activation code using the endpoint:

An active member who has been created within the endpoint: requests a password reset using

Member created via API:

in the Admin Panel

Member deactivated via the API:

to a member

The reward received from the

The reward bought from the

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

https://apidocs.openloyalty.io/#tag/Transactions/operation/_transactionPos
https://apidocs.openloyalty.io/#tag/Points/operation/pointsPostTransferCancel
https://apidocs.openloyalty.io/#tag/Transactions/operation/transactionPostMemberAssi
https://apidocs.openloyalty.io/#tag/Reward/operation/redemptionPostStatu
POST/api/{storeCode}/member/register
PUT/api/{storeCode}/member/{member}
POST/api/{storeCode}/member/{member}/send-code
POST/api/{storeCode}/member/resend-code
POST/api/{storeCode}/member/register
POST/api/{storeCode}/member/password/reset/reque
POST/api/{storeCode}/member
POST/api/{storeCode}/member/{member}/deactivat
Expiring Notifications
Expiring Notifications
Expiring Notifications
here
Manually assigning rewards
Camaign Effect
Reward Catalog
Member Deactivated