LogoLogo
HomepageCase studiesBook a demo
Technical Guide
Technical Guide
  • Introduction
  • Getting Started Guide
    • Authentication
    • Member Registration Configuration
    • Add Webhook
    • Add Member
    • Create Campaign
    • Add Transaction
    • Add Custom Event Schema
    • Create Achievement
    • Add Custom Event
  • Terms Reference
  • Backward Compatibility Policy
  • API Reference
  • Postman Collection
  • User Guide
  • Integration
    • Introduction
    • Overview of Integration Methods
    • Tools and Technologies
    • Integration Examples
      • Lambda
      • Zapier
      • AWS EventBridge
      • Kafka
  • API Fundamentals
    • Overview
    • Environments Capabilities
    • How to Query
    • Limits
    • Best Practices
  • Authentication
    • Admin Token
    • Access Token (API Key)
    • Enabling SSO Login
      • Okta
      • Microsoft Entra ID
  • Webhooks
    • Overview
    • Best Practices
  • S3 Bucket Data exports
    • Overview
    • Set Up S3 Bucket Integration
    • Data Structure and Types
      • Achievements
      • Achievement Usage
      • Campaigns
      • Campaign Calculated Effect Result
      • Campaign Execution
      • Custom Events
      • Members
      • Rewards
      • Rewards Redemption
      • Tiers
      • Transactions
      • Tenants
      • Unit Transfers
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks

Overview

Last updated 4 months ago

Was this helpful?

enable event-driven communication between Open Loyalty and your system. They are user-defined HTTP callbacks that trigger when specific events occur, such as earning points, redeeming rewards, or updating customer profiles. Webhooks use HTTP POST requests to send event data (usually in JSON format) to a preconfigured endpoint in your system.

To implement webhooks securely, consider the following measures:

  • Verification Tokens: Use a shared secret (verification token) to validate incoming webhook requests, ensuring that they originate from the intended sender.

  • HTTPS: Implement HTTPS for webhook endpoints to encrypt data in transit and protect against eavesdropping or tampering.

For an overview of Webhooks in Open Loyalty, .

For the list of available webhooks,

Webhooks
see here
see here.