Plugin V1

Plugin service for authenticated plugin access to incident.io APIs

Create Plugin V1

Create an escalation.

An escalation pages people, either according to an escalation path, or directly to specific users. You must provide either an escalation_path_id OR user_ids, but not both.

When escalating via an escalation path, the escalation will follow the configured path with its levels and timeouts, using your default alert priority.

When escalating directly to users, they will receive a high-urgency notification, based on their notification rules.

This endpoint is rate-limited to 60 requests per minute, since it is intended for interactive use cases (for example someone clicking a "escalate to team" button in your internal developer platform). To escalate based on automated alerts, we recommend sending events to an alert source instead.

Request
Request Body schema: application/json
required
description
string

Additional details about the escalation

escalation_path_id
string

ID of the escalation path to follow

idempotency_key
required
string

Unique key to prevent duplicate escalations. If this key has already been used, the existing escalation will be returned.

title
required
string

The title of the escalation. This message will be included in all notifications about this escalation.

user_ids
Array of strings

IDs of users to escalate directly to

Responses
201

Created response.

post/v1/api/plugin/escalations
Request samples
application/json
{
  • "description": "Database CPU has been above 90% for 5 minutes",
  • "escalation_path_id": "01H0J1EXE7AXZ2C93K61WBPYEH",
  • "idempotency_key": "2024-01-15-abc123",
  • "title": "Production database experiencing high CPU",
  • "user_ids": [
    ]
}
Response samples
application/json
{
  • "escalation": {
    }
}