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.

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 token and storeCode 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

Create a custom event schema

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

POSThttp://openloyalty.localhost/api/{storeCode}/customEvent/schema

Path parameters

storeCode*string

Store code

Body

application/json

customEventSchemaCreateFormType (object)

Response

204400401403

Success. No content.

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/{storeCode}/customEvent/schema', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403

{
  "code": 400,
  "message": "Validation failed",
  "errors": [
    {
      "message": "text",
      "parameters": [],
      "plural": null,
      "code": "text",
      "path": "text"
    }
  ]
}

---

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:

Custom Event SchemasUser Guide