Page

Hotpot's API for paging

A page is an urgent notification that will be delivered to a user or users to get their attention on an issue.

POST /page/team

This will page a team's on-call(s) for the current stint. This is an asynchronous request, and you will need to use the hotpot_request_id returned to check its status via the Request endpoint.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
text	string	The full body of the page, with any details someone would need to address the issue.
title	string	A short summary of the reason for the page.
recipient	string	The target for the page. This should be the team's slug, found on the Team Settings page.
source_url	string	An optional URL that Hotpot provide to a user to get more information about this page. Commonly a link to a triggered alert, etc.
urgency	string	An optional urgency. One of low, medium or high. Defaults to medium.

Response

200

{
  "hotpot_request_id": <a unique character string>,
  "response": {
        "success": true,
        "message": "Your request has been queued."
    }
}

400

{
  "error: "Bad Request"
}

An example of a JSON body for a page after an automatic sandwich-maker experiences a problem:

{
  "text": "The peanut butter dispenser is jammed and requires maintenance."
  "title": "SandwichBot needs attention"
  "recipient": "peanut-butter-ops"
}

Page a person

POST /page/person

Page a person directly. This will ignore on-call rotations and availability, and page that specific person, so be careful when using this. This is an asynchronous request, and you will need to use the hotpot_request_id returned to check its status via the Request endpoint.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
text	string	The full body of the page, with any details someone would need to address the issue.
title	string	A short summary of the reason for the page.
recipient	string	The target for the page. This should be the target's email address.
recipient	string	An optional URL that Hotpot provide to a user to get more information about this page. Commonly a link to a triggered alert, etc.
urgency	string	An optional urgency. One of low, medium or high. Defaults to medium.

Response

200

{
  "hotpot_request_id": <a unique character string>,
  "response": {
        "success": true,
        "message": "Your request has been queued."
    }
}

400

{
  "error: "Bad Request"
}

An example of a JSON body for a page when there is an issue specific to a particular person:

{
  "text": "Lex Luthor and his robot army are taking over the city!"
  "title": "Metropolis needs you!"
  "recipient": "[e-mail]"
}