Moment

Hotpot's API for moments

Moment

A moment represents a human-scale or control-plane event during an on-call stint. We emphasize human scale as Hotpot is intended to capture things that happen to people or things that people do. Some of these moments might be mundane: a flapping alert, the deployment of a new release, or a near-miss. Other moments are more aberrant, such as incidents or being paged at 3 a.m.

Moments generally come from integrations, but we encourage you to use this API to create moments from tooling inside your organization!

Add a moment

POST /moment/:token

This endpoint allows you to create a Moment in Hotpot. The value for token is available via Teams > Team Settings > Moment API in Hotpot. Moment creation is asynchronous; please use the Request endpoint to check its processing status.

Note that creating a Moment of type page does not page anyone. To do that, use the Page API.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
name	string	A name for your Moment, e.g. "500 error in production"
type	string	The type of Moment. This can be "Alert", "Incident", "Near-miss", or "Page"
description	string	A longer description of the Moment, to provide more context and assist in triage
priority	string	Priority of the Moment. This can be high, medium (the default), or low.

Response

200

{
    "hotpot_request_id": "f1e5ae0a-f90c-4dac-affa-2eda897f5c3f",
    "response": {
        "success": true,
        "message": "Your request has been queued."
    }
}