> For the complete documentation index, see [llms.txt](https://eshop.gitbook.io/eshopbox-developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eshop.gitbook.io/eshopbox-developers/advanced/events-webhook/event-payload.md).

# Event Payload

The payload delivered to your webhook `url` will contain information about the fired event.

The payload attributes and types are defined below.

| Attribute      | Type     | Description                                                                                                                                                                                |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `resource`     | `string` | The resources affected by this event. Refer here for resource types available.                                                                                                             |
| `eventType`    | `string` | <p>It describes the CRUD format of event .</p><p>Example: <code>POST</code> ,<code>PUT</code> etc.</p>                                                                                     |
| `eventSubType` | `string` | This defines the event verb specifically for an event Type. Refer [Observable Events](https://docs.eshopbox.com/advanced/events-webhook/observable-events) for the defined event subtypes. |
| `version`      | `string` | It is used for versioning the Events.                                                                                                                                                      |
| `accountSlug`  | `string` | It defined the account which has generated the event                                                                                                                                       |
| `accountId`    | `number` | It defines the id of the account which has generated the event                                                                                                                             |
| `responseData` | `object` | This object can differ for different events. It contains metadata about the event.                                                                                                         |

## Sample Json

```
{
   "resource": "fee_rule",
   "eventType": "POST",
   "eventSubType": "created",
   "accountSlug": "KapasKraft",
   "accountId": "1",
   "version": "v1",
   "responseData": {
       "userName": "Kapas Kraft",
       "portalId": "1",
       "portalName": "Amazon",
       "feeType": "Commission fee",
       "validFrom": "Friday 23 Aug 2019",
       "validTo": "Friday 23 Aug 2019",
       "clientId": "1",
       "feeId": "123",
       "feeVersion": "77",
       "requestType":"0",
       "emailTo": {
           "John Doe": "johndoe@gmail.com"
       },
       "noteUrl": "https://auth.auperator.co/settings/fees-details/portalId/feeId/feeVersion",
       "actionButton1Url":"https://auth.auperator.co/settings/fees-details/3/29/1.2",
       "actionButton2Url":"https://auth.auperator.co/settings/transaction-rule-add"
   }
}
```


---

# 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://eshop.gitbook.io/eshopbox-developers/advanced/events-webhook/event-payload.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.