Page

A page is an urgent notification delivered to a user or users to get their attention on an issue. Page creation is asynchronous; use the Request endpoint to check its processing status.

Page a team

POST /page/team

This pages a team's on-call(s) for the current shift.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <your API key>

Parameters

Name	Type	Description
text	string	The full body of the page, with any details needed 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 provides to a user to get more information about this page. Commonly a link to a triggered alert or the like.
urgency	string	An optional urgency, one of low, medium (the default), or high.

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 ignores on-call rotations and availability to page that specific person, so be careful when using this.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <your API key>

Body

Name	Type	Description
text	string	The full body of the page, with any details needed 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.
source_url	string	An optional URL that Hotpot provides to a user to get more information about this page. Commonly a link to a triggered alert or the like.
urgency	string	An optional urgency, one of low, medium (the default), or high.

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's an issue specific to a particular person:

{
  "text": "Lex Luthor and his robot army are taking over the city!",
  "title": "Metropolis needs you!",
  "recipient": "superman@example.com"
}