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
  1. Getting Started Guide

Add Custom Event

See the sample example of how a custom event can be added. Links to more detailed instructions can be found at the end of the article.

Last updated 11 months ago

Was this helpful?

How this example works

In this example, we will create a sample custom event to trigger the previously created achievement.


Try yourself

  • Input the previous saved and in the request header

  • Add a transaction Endpoint: POST /api/{storeCode}/customEvent

    {
      "event": {
        "type": "app_login",
        "eventDate": "2024-05-01T00:00:00", // add current time
        "customerData": {
          "email": "john.smith@example.com"
        }
      }
    }
  • This action should trigger MemberAchievementProgressWasChanged

The webhook will be triggered each time there is progress made towards the achievement's goal, not only when the achievement is completed.

In this example, the custom event would have to be sent each day over the span of 7 days for the member to complete the previously set up achievement.


Endpoints used


More resources

For a detailed overview and description of the transactions creation and management, please refer to these series of articles:

token
storeCode
webhook

Create a custom event

post

This method allows creating a new Custom Event in the system.

Authorizations
Path parameters
storeCodestringRequired

Store code

Body
eventall ofOptional
and
Responses
200
Custom event created successfully
application/json
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden.
application/json
post
POST /api/{storeCode}/customEvent HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 213

{
  "event": {
    "type": "text",
    "customerData": {
      "customerId": "7239e6f7-e52e-466b-8c24-699709b64076",
      "email": "text",
      "phone": "text",
      "loyaltyCardNumber": "text"
    },
    "eventDate": "2025-06-14T10:31:11.957Z",
    "body": {
      "key": "value"
    }
  }
}
{
  "customEventId": "00000000-0000-0000-0000-000000000000"
}
Custom EventsIn this section, you will learn about adding and managing custom events in Open Loyalty.