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 for tooling inside your organization!

List moments

GET /api/moment

This endpoint allows you to retrieve a paginated list of all your moments. By default, a maximum of ten moments are shown per page.

Headers

NameValue

Content-Type

application/json

Authorization

Token token="…"

Body

NameTypeDescription

limit

integer

Limit the number of moments returned.

Response

{
  "id": 1,
  "name": "John",
  "age": 30
}

Create a new moment

POST /api/moment

This endpoint allows you to add a new moment.

Headers

NameValue

Content-Type

application/json

Authorization

Token token="…"

Body

NameTypeDescription

name

string

Name of the user

age

number

Age of the user

Response

{
  "id": 1,
  "name": "John",
  "age": 30
}

Last updated