> For the complete documentation index, see [llms.txt](https://user.netmera.com/netmera-developer-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://user.netmera.com/netmera-developer-guide/api-documentation/rest-api/events.md).

# Events

### Fire Event

The `fireEvents` endpoint is used to send custom events associated with a specific user. Each event must include the `extId` parameter to identify the user and a `name` parameter to specify the event type. Additional attributes can be included as key-value pairs, based on the event schema defined in the Netmera panel.

#### Endpoint

```
POST /rest/3.0/fireEvents
```

#### Request Headers

* `X-netmera-api-key`: Your REST API key
* `Content-Type`: `application/json`

#### Request Body

The body must be a JSON array of event objects. Each object should contain the following fields:

* `extId` (string, required): Unique identifier of the user in your system.
* `name` (string, required): Name of the event.
* Custom parameters (optional): Additional event-specific attributes (must match the schema defined in the panel).

#### Example – Custom Event

```json
curl -X POST https://restapi.netmera.com/rest/3.0/fireEvents \
  -H "X-netmera-api-key: your_rest_api_key" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "extId": "id_in_my_system_1",
      "name": "ShareEvent",
      "itemId": "4234",
      "channel": "Facebook"
    }
  ]'
```

### Cancel Order Event

This example demonstrates how to fire an `OrderCancelEvent` with relevant order-related attributes. The fields used in this example must be configured in the event schema through the Netmera panel.

#### Example – Cancel Order Event

```json
curl -X POST https://restapi.netmera.com/rest/3.0/fireEvents \
  -H "X-netmera-api-key: your_rest_api_key" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "extId": "id_in_my_system_1",
      "name": "OrderCancelEvent",
      "paymentMethod": "Credit Card",
      "subTotal": 20.0,
      "itemCount": 4,
      "grandTotal": 35.0
    }
  ]'
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://user.netmera.com/netmera-developer-guide/api-documentation/rest-api/events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.