> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/technical-guide/getting-started-guide/add-custom-event-schema.md).

# 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 <a href="#to-try-it-yourself" id="to-try-it-yourself"></a>

* Input the previous saved [token](/technical-guide/getting-started-guide/authentication.md) and [storeCode](/technical-guide/getting-started-guide/member-registartion-configuration.md#to-try-it-yourself) in the request header
* Add a custom event schema\
  Endpoint: `POST /api/{storeCode}/customEvent/schema`

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

{% hint style="info" %}
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.
{% endhint %}

***

## Endpoints used

{% openapi src="/files/jvocRY6tlAWocBwKFsNL" path="/api/{storeCode}/customEvent/schema" method="post" %}
[openapi-5.61.0 (1).json](https://123136216-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgIv2CyIIYf7vRfuhMKQ6%2Fuploads%2Fgit-blob-c6d6d1ae03b533a9dcf7bf7e18c3fbc4e23b0e6b%2Fopenapi-5.61.0%20\(1\).json?alt=media)
{% endopenapi %}

***

## 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:

{% content-ref url="/spaces/cNVX03KZzmrGwJihLiEx/pages/kLAEcvOMad1u0l6UBdci" %}
[Custom Event Schemas](/members-and-activity/custom-events/custom-event-schemas.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.openloyalty.io/technical-guide/getting-started-guide/add-custom-event-schema.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.