Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 4.29 KB

webhook.md

File metadata and controls

99 lines (69 loc) · 4.29 KB
title seoTitle description date weight
Webhook Integration
iLert: Webhook Integration for Alerting | Incident Response | Uptime
The iLert Webhook Integration helps you to easily connect iLert with Webhooks.
2018-12-29T05:02:05.000Z
1

Webhook Integration

In iLert: Create webhook connection

  1. Switch to the alert sources tab and open the alert source whose incidents you want to publish via a webhook. Click on Connections → Add new connection

  1. Select Webhook as type and fill out all fields. In the Webhook Trigger field, select the incident events for which you want to receive a webhook call. Webhook events are sent as HTTP POST to the specified URL. The URL must be accessible from the internet. Click on Save.

  1. Finished! You can now test the connection by clicking the Test this connection button.

Webhook payload

A sample webhook payload can be seen below.
To get more information on the status or eventType fields, visit the Template variables explained section of this page.

{
     "id": "2983781",
     "status": "ACCEPTED",
     "summary": "PROBLEM Host Alert: app.compute is DOWN",
     "details": "details,
     "reportTime": "2019-08-29T09: 52: 39.551Z",
     "eventType": "incident-acknowledged",
     "alertSource": {
         "id": 2101194,
         "name": "Nagios Network and Hosts"
     },
     "assignedTo": {
         "username": "abr",
         "email": " [email protected] ",
         "firstName": "Andreas",
         "lastName": "farmer"
     }
}

Custom webhook payload / request body

In case you want to customize the HTTP Post request body of your webhook, you can simply enable the custom fields option.

This will allow you to add any kind of custom body that you want to send. In case of an invalid template the border will become yellow or red.

In case of a valid template the border will turn green. As you may have noticed we also offer to use iLert related variables that will be swapped with the corresponding event related data when the request is made. These work, as described under the template field in simple mustache sytnax {{ VARNAME }}. Our editor will tell you if you are using the variables incorrectly.

Template variables explained

Variable key Description
incidentId The ID of the incident
incidentDetails Full incident details
incidentSummary Incident summary
incidentStatus PENDING, ACCEPTED or RESOLVED
incidentUrl URL that links to the incident in iLert
alertSourceId The ID of the incident's alert source
alertSourceName The name of the incident's alert source
escalationPolicyId The ID of the escalation policy of the incident's alert source
escalationPolicyName The name of the escalation policy of the incident's alert source
reportTime ISO-8601 representation of the incident report time
link If present, the first link in the incident's payload e.g. links to the origin monitoring tool that send the event initially
eventType incident-created, incident-assigned, incident-auto-escalated, incident-auto-resolved, incident-acknowledged, incident-rejected, incident-raised, incident-comment-added, incident-resolved

FAQ

Do you support authentication?

Yes, HTTP Basic Auth is supported. The username and password must be specified in the URL.

Example: https: // username: [email protected] / webhooks / ilert

Special characters in the user name or password must be encoded URL.

Can you also specify the HTTP port?

Yes. By default, port 80 is used for HTTP connections and port 443 for HTTPS connections. You can overwrite the port number by adding a colon : after the host address and the port.

incident-created, incident-assigned, incident-auto-escalated, incident-auto-resolved, incident-acknowledged, incident-rejected, incident-raised, incident-comment-added, incident-resolved

Example: https://example.com:8443/webhooks/ilert