Escalations

Fetch list of escalations

get

An escalation policy is a simple set of rules to alert the right person at the right time using the right channel such as phone, slack or email. If that person misses out then the incident gets escalated to the next person.

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

get

/escalations

HTTPcURLJavaScriptPython

GET /escalations HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Get escalation policy details

get

Get details of an escalation policy. Includes escalation policy name, description, and escalation rules.

Path parameters

escalationIdstringRequired

escalationId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/escalations/{escalationId}

HTTPcURLJavaScriptPython

GET /escalations/{escalationId} HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Fetch escalations using an on-call

get

Get a list of escalation policies that reference a specific on-call schedule. Useful for understanding which escalations will be affected if you modify or delete an on-call schedule.

Path parameters

oncallIdstringRequired

oncallId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

get

/on-calls/{oncallId}/escalations

HTTPcURLJavaScriptPython

GET /on-calls/{oncallId}/escalations HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}

Create an escalation policy

post

Create a new escalation policy for a team. An escalation policy defines who gets notified, how (via which channel), and the delay between steps.

Request Body:

• name (required): A descriptive name for the escalation policy.

• escalation (required): An array of steps. Each step is an array of notification rules that fire in parallel. Steps are executed sequentially — Step 2 fires only if Step 1 is not acknowledged within its interval.

• delay (optional): Delay in minutes before the first step begins (default: 0).

Notification rule fields:

• interval: Time in minutes to wait before escalating to the next step. Only required in the first step.

• via: The notification channel — one of email, sms, phone, whatsapp, push-notification, slack, telegram, or ms-teams.

• oncall: Reference to an on-call schedule { "id": "<on-call-id>" }. The currently on-call user will be notified.

• user: Reference to a specific user { "id": "<user-id>" }. Use this to always notify a fixed person.

• channel: (Slack/MS Teams only) The channel to post to { "id": "<channel-id>", "value": "<channel-name>", "isPrivate": "false" }.

• mention: (Slack only) Mention config { "id": "false", "value": "No mention" }.

Tip: Use oncall to route alerts to whoever is currently on-call, or user to always alert a specific person.

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Body

application/json

namestringOptional

delaystringOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

post

/escalations/create

HTTPcURLJavaScriptPython

POST /escalations/create HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 590

{
  "name": "Production Critical Alerts",
  "escalation": [
    [
      {
        "interval": "10",
        "via": "email",
        "oncall": {
          "id": "<on-call-schedule-id>"
        }
      },
      {
        "interval": "10",
        "via": "sms",
        "oncall": {
          "id": "<on-call-schedule-id>"
        }
      },
      {
        "interval": "10",
        "via": "phone",
        "oncall": {
          "id": "<on-call-schedule-id>"
        }
      },
      {
        "interval": "10",
        "via": "push-notification",
        "user": {
          "id": "<user-id>"
        }
      }
    ],
    [
      {
        "interval": "",
        "via": "slack",
        "channel": {
          "id": "<slack-channel-id>",
          "value": "incidents",
          "isPrivate": "false"
        },
        "mention": {
          "id": "false",
          "value": "No mention"
        }
      },
      {
        "interval": "",
        "via": "push-notification",
        "oncall": {
          "id": "<on-call-schedule-id-2>"
        }
      }
    ]
  ],
  "delay": "0"
}

{}

Update an escalation policy

put

Update an existing escalation policy by its ID. Pass the escalation policy _id in the URL and provide the full updated policy in the request body.

You must send the complete escalation structure — partial updates are not supported. The existing policy will be fully replaced with the provided data.

Request Body:

• name (required): Updated name for the escalation policy.

• escalation (required): The full array of escalation steps (same format as Create).

• delay (optional): Delay in minutes before the first step (default: 0).

See the Create an escalation policy endpoint for detailed field descriptions and notification channel options.

Path parameters

escalationIdstringRequired

escalationId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Body

application/json

namestringOptional

delaystringOptional

Responses

200

Successful response

application/json

objectOptional

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

put

/escalations/{escalationId}/update

HTTPcURLJavaScriptPython

PUT /escalations/{escalationId}/update HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Content-Type: application/json
Accept: */*
Content-Length: 589

{
  "name": "Updated Production Alerts",
  "escalation": [
    [
      {
        "interval": "10",
        "via": "email",
        "oncall": {
          "id": "<on-call-schedule-id>"
        }
      },
      {
        "interval": "10",
        "via": "sms",
        "oncall": {
          "id": "<on-call-schedule-id>"
        }
      },
      {
        "interval": "10",
        "via": "phone",
        "oncall": {
          "id": "<on-call-schedule-id>"
        }
      },
      {
        "interval": "10",
        "via": "push-notification",
        "user": {
          "id": "<user-id>"
        }
      }
    ],
    [
      {
        "interval": "",
        "via": "slack",
        "channel": {
          "id": "<slack-channel-id>",
          "value": "incidents",
          "isPrivate": "false"
        },
        "mention": {
          "id": "false",
          "value": "No mention"
        }
      },
      {
        "interval": "",
        "via": "push-notification",
        "oncall": {
          "id": "<on-call-schedule-id-2>"
        }
      }
    ]
  ],
  "delay": "0"
}

{}

Archive an escalation policy

delete

Archive (soft-delete) an escalation policy by its ID. Archived escalation policies will no longer be active and won't appear in the default escalation list.

Important: Before archiving, make sure no active integrations are using this escalation policy. Archiving an in-use policy may result in incidents not being escalated properly.

Pass the escalation policy _id as a path parameter. No request body is required.

Path parameters

escalationIdstringRequired

escalationId parameter

Header parameters

x-api-keystringRequired

Your API key. Find it in your Spike dashboard under Settings > API.

x-team-idstringRequired

Team ID of the team you are making the request to.

Responses

200

Successful response

application/json

objectOptional

401

Unauthorized

application/json

404

Not found

application/json

delete

/escalations/{escalationId}/archive

HTTPcURLJavaScriptPython

DELETE /escalations/{escalationId}/archive HTTP/1.1
Host: api.spike.sh
x-api-key: text
x-team-id: text
Accept: */*

{}