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.

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 token and storeCode 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": "[email protected]"
      }
    }
  }

• This action should trigger MemberAchievementProgressWasChanged webhook

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

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

HTTPcURLJavaScriptPython

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-07-04T20:31:38.080Z",
    "body": {
      "key": "value"
    }
  }
}

{
  "customEventId": "00000000-0000-0000-0000-000000000000"
}

---

More resources

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

Custom EventsIn this section, you will learn about adding and managing custom events in Open Loyalty.