> For the complete documentation index, see [llms.txt](https://docs.alemba.com/asm-hermes/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.alemba.com/asm-hermes/integrate/managing-integration/webhooks/webhook-payloads.md).
# Webhook Payloads
## Supported Event Entity Types
* Call
* CMDB item
* Knowledge
* CMDB Link
* Person
* Request
* Task
Attachments (Upload, Update and Delete)
Released: 10.6.8.14016
```
Payload Options:
1. Include all attachments in payload
2. Attachment Name Filter
3. Attachment Size Limit
4. Number of Attachments oer Payload Limit
```
This is enabled via a registry key on the System: When the "**Include all attachments in payload**" option is enabled, it will include the attachments of that entity in the payload.
Example:
{% code overflow="wrap" %}
```
{ "Action": "Forwarded", "Call": { "Ref": 757, ...omitted for ease of reading } }, "Attachments": [ { "Ref": 1720, "Name": "Test3.txt", "FileSize": 12, "ContentType": "text/plain", "Data": "VGVzdCBjb250ZW50" }, { "Ref": 1719, "Name": "NewTest1.txt", "FileSize": 12, "ContentType": "text/plain", "Data": "VGVzdCBjb250ZW50" } ] }
```
{% endcode %}
* "**Attachment Name Filter**" - Allows the admin to configure regular expressions to filter what attachments get included by their name. multiple regular expressions can be defined separated by a semi colon ";"
* "**Attachment Size Limit**" - Allows the admin to configure a max size of attachment to be included. When greater than 0 (no limit), it will filter what attachments get included based on file size (in kilobytes).
* "**Number of Attachments per Payload Limit**" - The maximum number of attachments to be included in the payload. When greater than 0 (no limit), it will select the newest (uploaded/updated most recently) attachments, until the limit is reached.
A new activity log entry will be added for webhooks which indicate what attachments have been included/excluded from the payload.
Inline images when they are contained within HTML
Released: 10.6.8.13255
Parameters: Inline Images should have **src** set to **base64** encoded content.
Last History
Released: 10.6.9.14735
```
Action: ActionAddedtoHistory
Property: ActionHistoryId
```
If a history record exists for the action, then it will add the ref to the payload using the ActionHistoryId property
This functionality only applies to Calls, Requests and Tasks at the moment. The **ActionHistoryId** property will not be added to the "ObjectAttached" action, but should be added to the corresponding "**ActionAddedToHistory**" action.
```xml
{
"Action": "Closed",
"ActionHistoryId": 16,
"Call": {
"Ref": 404,
.....
```
The **ActionHistoryId ref** can then be used to retrieve the history item via the Alemba API.
{% code overflow="wrap" %}
```
api/v2/call/404/history?$select=Order,ActionTitle,ActionDescription&$Filter=Order=18
```
{% endcode %}
Last Note Added
Released: 10.6.8.13574
```
Payload Options:
1. LastUpdate
2. LastUpdateHtml
```
You can add the last note added to a ticket as part of the webhook payload.
Add LastUpdate and LastUpdateHtml to webhook payload. The description and description html from the most recent user action will be added to the webhook payload when these fields are added to Payload select in admin.
Include All Attachments
Released: 10.6.8.13574
{% code overflow="wrap" %}
```
Payload Options:
1. Attachment Name Filter
2. Attachment Size Limit
3. Number of Attachments per Payload Limit
```
{% endcode %}
You can include all the attachments to be sent (as long as they meet the configured criteria):
This is enabled via a registry key on the System:
When the "Include all attachments in payload" option is enabled it will include the attachments of that entity in the payload.
Example:
```
{
"Action": "Forwarded",
"Call": {
"Ref": 757,
...omitted for ease of reading
}
},
"Attachments": [
{
"Ref": 1720,
"Name": "Test3.txt",
"FileSize": 12,
"ContentType": "text/plain",
"Data": "VGVzdCBjb250ZW50" },
{
"Ref": 1719,
"Name": "NewTest1.txt",
"FileSize": 12,
"ContentType": "text/plain",
"Data": "VGVzdCBjb250ZW50" }
]
}
```
### Additional Options for Include All Attachments
* "Attachment Name Filter" - Allows the admin to configure regular expressions to filter what attachments get included by their name. multiple regular expressions can be defined separated by a semi colon ";"
* "Attachment Size Limit" - Allows the admin to configure a max size of attachment to be included. When greater than 0 (no limit), it will filter what attachments get included based on file size (in kilobytes).
* "Number of Attachments per Payload Limit" - The maximum number of attachments to be included in the payload. When greater than 0 (no limit), it will select the newest (uploaded/updated most recently) attachments, until the limit is reached.
A new activity log entry will be added for webhooks which indicate what attachments have been included/excluded from the payload.
---
# 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://docs.alemba.com/asm-hermes/integrate/managing-integration/webhooks/webhook-payloads.md?ask=&goal=
```
`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.