Skip to main content
WEBHOOK
public_alert.alert_created_v1
{
  "event_type": "public_alert.alert_created_v1",
  "public_alert.alert_created_v1": {
    "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
    "attributes": [
      {
        "array_value": [
          {
            "catalog_entry": {
              "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
              "id": "01FCNDV6P870EA6S7TK1DSYDG0",
              "name": "Primary On-call"
            },
            "label": "Payments Team",
            "literal": "SEV123"
          }
        ],
        "attribute": {
          "array": false,
          "id": "01GW2G3V0S59R238FAHPDS1R66",
          "name": "service",
          "required": false,
          "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
        },
        "value": {
          "catalog_entry": {
            "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "name": "Primary On-call"
          },
          "label": "Payments Team",
          "literal": "SEV123"
        }
      }
    ],
    "created_at": "2021-08-17T13:28:57.801578Z",
    "deduplication_key": "4293868629",
    "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "resolved_at": "2021-08-17T14:28:57.801578Z",
    "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
    "status": "firing",
    "title": "*errors.withMessage: PG::Error failed to connect",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Response

200 - application/json

OK response.

​
event_type
enum<string>
required

What type of event is this webhook for?

Available options:
public_incident.incident_created_v2,
private_incident.incident_created_v2,
public_incident.incident_updated_v2,
private_incident.incident_updated_v2,
public_incident.incident_status_updated_v2,
public_incident.follow_up_created_v1,
private_incident.follow_up_created_v1,
public_incident.follow_up_updated_v1,
private_incident.follow_up_updated_v1,
public_incident.follow_up_created_v2,
private_incident.follow_up_created_v2,
public_incident.follow_up_updated_v2,
private_incident.follow_up_updated_v2,
public_incident.action_created_v1,
private_incident.action_created_v1,
public_incident.action_updated_v1,
private_incident.action_updated_v1,
public_alert.alert_created_v1,
private_alert.alert_created_v1,
private_incident.membership_granted_v1,
private_incident.membership_revoked_v1
Example:

"public_alert.alert_created_v1"

​
public_alert.alert_created_v1
object
required
Example:
{
  "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
  "attributes": [
    {
      "array_value": [
        {
          "catalog_entry": {
            "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "id": "01FCNDV6P870EA6S7TK1DSYDG0",
            "name": "Primary On-call"
          },
          "label": "Payments Team",
          "literal": "SEV123"
        }
      ],
      "attribute": {
        "array": false,
        "id": "01GW2G3V0S59R238FAHPDS1R66",
        "name": "service",
        "required": false,
        "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
      },
      "value": {
        "catalog_entry": {
          "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "name": "Primary On-call"
        },
        "label": "Payments Team",
        "literal": "SEV123"
      }
    }
  ],
  "created_at": "2021-08-17T13:28:57.801578Z",
  "deduplication_key": "4293868629",
  "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
  "id": "01GW2G3V0S59R238FAHPDS1R66",
  "resolved_at": "2021-08-17T14:28:57.801578Z",
  "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
  "status": "firing",
  "title": "*errors.withMessage: PG::Error failed to connect",
  "updated_at": "2021-08-17T13:28:57.801578Z"
}