API deployment pipeline
Last updated
Last updated
(c) 2011 - 2024 ilert GmbH
If you wish to integration your custom deployment or CI & CD pipelines with ilert's deployment events, you can use the generic API deployment pipeline to generate an integrationKey
and process your own events. Additionally deployment events are not only bound to modern cloud based software deployments, instead other sectors and tools might fire relevant deployment events as well, such as:
Digital Marketing Campaigns (launching campaigns)
Product Launches in Retail
Supply Chain Management (transitioning goods)
Education and E-Learning (courses)
Regulatory Compliance Releases (financial services or healthcare)
Content Publishing
Healthcare Systems (health data)
In any case our API deployment helps you setup such flows:
In any way a pipeline is required, which will also generate a new integrationKey
required to route deployment events when they occur. Head to your ilert account and navigate to Alert sources -> Deployment events
Head over to the deployment pipelines tab and click on Create new pipeline
Provide a name for your pipeline
Clicking on Create you should end up on the detail view of your new API deployment pipeline.
Providing you with a freshly generated integrationKey
and the copy & pastable URL ready for your client setup.
To send deployment events to ilert and POST HTTP request is needed containing the integrationKey
as body field. The full API docs can be found here: https://api.ilert.com/api-docs/#tag/deployment-events/post/deployment-events
A sample curl request might look like this:
Note that only the integrationKey
and summary
fields are required. All others are optional. The timestamp
fields support epochSeconds, epochMilliseconds or ISO8601 datetime strings.