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 Schema

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

Last updated 10 months ago

Was this helpful?

How this example works

In this example, we will set up a sample custom event schema to trigger the achievement created in the next step.


Try yourself

  • Input the previous saved and in the request header

  • Add a custom event schema Endpoint: POST /api/{storeCode}/customEvent/schema

    {
        "customEventSchema": {
            "eventType": "app_login",
            "schema": {},
            "name": "User Logged In",
            "active": {
                "isActive": true
            }
        }
    }
  • 204 No Content status indicates the custom event schema was successfully created.

Although it is not included in this scenario, the custom event schema enables you to specify more detailed attributes that can be tracked by the achievements and campaigns.


Endpoints used


More resources

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

token
storeCode
Custom Event SchemasIn this section, you will learn how to manage the custom event schemas.

Create a custom event schema

post

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

Authorizations
Path parameters
storeCodestringRequired

Store code

Body
Responses
204
Success. No content.
400
Bad request.
application/json
401
Unauthorized
application/json
403
Forbidden.
application/json
post
POST /api/{storeCode}/customEvent/schema HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "customEventSchema": {
    "eventType": "text",
    "schema": {
      "fields": [
        {
          "type": "text",
          "description": "text",
          "name": "text"
        }
      ]
    },
    "name": "text"
  }
}

No content