Alert Events V2

Create alerts within incident.io.

The alerts API allows you to create alerts within incident.io by posting alert events. You can use alerts to automatically trigger incidents.

To create an alert, you must first configure an alert source in the incident.io dashboard.

CreateHTTP Alert Events V2

Create an alert event using an HTTP source.

Request

path Parameters

alert_source_config_id

required

string

Which alert source config produced this alert

Example: 01GW2G3V0S59R238FAHPDS1R66

query Parameters

token

string

Token used to authenticate the request, generated when configuring the alert source. Will be consumed via a URL query string parameter

Example: token=some-random-string

Request Body schema: application/json
required

deduplication_key	string A deduplication key can be provided to uniquely reference this alert from your alert source. If you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config.
description	string Description that optionally adds more detail to title. Supports markdown.
	object Any additional metadata that you've configured your alert source to parse
source_url	string If applicable, a link to the alert in the upstream system
status required	string Current status of this alert Enum: "firing" "resolved"
title required	string Alert title which is used when summarising the alert

Responses

202

Accepted response.

post/v2/alert_events/http/{alert_source_config_id}

Request samples

Payload
curl

application/json

{"deduplication_key": "4293868629",
"description": "We've detected a number of timeouts on hello.world.com, the service may be down. To fix...",
"metadata": {"service": "hello.world.com",
"team": ["my-team"
]
},
"source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
"status": "firing",
"title": "*errors.withMessage: PG::Error failed to connect"
}

Response samples