Sign in
latestSwagger 2.02026-08-102194011.3 MB

602fc25ddd76

Alert Events V2

CreateHTTP Alert Events V2

Create an alert event using an HTTP source.

post/v2/alert_events/http/{alert_source_config_id}

Path parameters

alert_source_config_idstring required

Which alert source config produced this alert

Query parameters

tokenstring

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

Headers

authorizationstring

Whatever is provided in the Authorization header. We support either Basic or Bearer authorization with the secret provided on the alert source.

Request body

deduplication_keystring

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.

descriptionstring

Description that optionally adds more detail to title. Supports markdown.

metadataobject

Any additional metadata that you've configured your alert source to parse

source_urlstring

If applicable, a link to the alert in the upstream system

status'firing' | 'resolved' required

Current status of this alert

titlestring required

Alert title which is used when summarising the alert

Example request

{
  "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

Accepted response.

deduplication_keystring required

The deduplication key that the event has been processed with

messagestring required

Human readable message giving detail about the event

statusstring required

Status of the event

Example response

{
  "deduplication_key": "unique-key",
  "message": "Event accepted for processing",
  "status": "success"
}