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

# Deployment Events

## Post a deployment event to ilert.

> Use the Deployment events API to integrate your CI & CD tools or custom deployment workflows with ilert. Create a new deployment pipeline to generate an integration key for this endpoint.

```json
{"openapi":"3.0.1","info":{"title":"ilert REST API","version":"v2.2026.9-r.4"},"tags":[{"name":"Deployment Events"}],"servers":[{"url":"/api"}],"security":[],"paths":{"/deployment-events":{"post":{"tags":["Deployment Events"],"summary":"Post a deployment event to ilert.","description":"Use the Deployment events API to integrate your CI & CD tools or custom deployment workflows with ilert. Create a new deployment pipeline to generate an integration key for this endpoint.","requestBody":{"description":"The event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentEvent"}}},"required":true},"responses":{"202":{"description":"The event has been accepted","content":{}}}}}},"components":{"schemas":{"DeploymentEvent":{"type":"object","required":["integrationKey","summary"],"properties":{"integrationKey":{"type":"string"},"summary":{"type":"string"},"timestamp":{"type":"integer","format":"int64"},"userEmail":{"description":"Optional email used to map the event to a specific user in ilert","type":"string","format":"email"},"customDetails":{"type":"object","additionalProperties":true},"links":{"type":"array","items":{"$ref":"#/components/schemas/EventLink"}},"version":{"type":"string","description":"Version of the deployed artifact, for example a semantic version."},"environment":{"type":"string","description":"Environment the deployment targets, for example production."},"commit":{"type":"string","description":"Commit the deployment was built from."},"repository":{"type":"string","description":"Repository the deployment originates from."},"userName":{"type":"string","description":"Name of the user who triggered the deployment. Useful when userEmail is unavailable or anonymized."}}},"EventLink":{"type":"object","properties":{"href":{"type":"string"},"text":{"type":"string"}}}}}}
```


---

# 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://docs.ilert.com/developer-docs/rest-api/api-reference/deployment-events.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.