Moment

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

warning

Creating a moment of type page does not page anyone. To do that, use the Page endpoint.

Add a moment

POST /moment/<token>

Use this endpoint to create a moment in Hotpot. The value for token is available under Teams > Team Settings > Webhooks in Hotpot. Existing webhooks endpoints are listed here. You can generate a new one by clicking New webhook at the top left.

Moment creation is asynchronous; use the Request endpoint to check its processing status.

Headers

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

Parameters

Name	Type	Description
name	string	A name for your moment, like "500 error in production".
type	string	The type of moment, one of: 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, one of: low, medium (the default), or high.

Response

200

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