Ritual

GET/api/v1/rituals/attempts/{attempt_id}

Get_attempt

Authorization

bearer_token

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/api/v1/rituals/attempts/string"

{  "armed_at_ms": 0,  "attempt_id": "string",  "deadline_ms": 0,  "performances": [    {      "part_id": "string",      "performed_by": "string",      "server_ts_ms": 0    }  ],  "rehearsal": true,  "report": null,  "ritual_def_id": "string",  "status": "armed"}

POST/api/v1/rituals/attempts/{attempt_id}/checkin

Checkin

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

part_id*string

Part being checked in (inverse mode); the caller must be the assigned actor

`application/json`

curl -X POST "https://example.com/api/v1/rituals/attempts/string/checkin" \  -H "Content-Type: application/json" \  -d '{    "part_id": "string"  }'

{  "attempt_id": "string",  "next_deadline_ms": 0,  "part_id": "string",  "status": "armed"}

POST/api/v1/rituals/attempts/{attempt_id}/countdown

Countdown

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

seconds?|

Number of seconds until the synchronized go-signal opens the window

Formatint32

Range0 <= value

`application/json`

curl -X POST "https://example.com/api/v1/rituals/attempts/string/countdown" \  -H "Content-Type: application/json" \  -d '{}'

{  "attempt_id": "string",  "channel": "string",  "seconds": 0,  "window_open_ms": 0}

POST/api/v1/rituals/attempts/{attempt_id}/perform

List_definitions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

q?string

Full-text search over this list's searchable fields.

Length1 <= length <= 200

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: name, version, created_at. Default: -created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rituals/definitions"

{  "definitions": [    {      "arm_ttl_seconds": 0,      "checkin_interval_seconds": 0,      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "description": "string",      "escalation": [        {          "action": "notify",          "after_missed_seconds": 0,          "pubsub_channel": "string",          "webhook_ids": [            "string"          ]        }      ],      "mode": "forward",      "name": "string",      "on_complete": null,      "on_dispute": "none",      "ordering": [        "string"      ],      "parts": [        {          "actor_type": "user",          "assigned_to": "string",          "part_id": "string"        }      ],      "quorum": {        "of": 0,        "required": 0      },      "ritual_def_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "version": 0,      "window_ms": 0    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

POST/api/v1/rituals/definitions

Create_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

arm_ttl_seconds?|

Time-to-live for an armed attempt in seconds

Formatint64

Range0 <= value

checkin_interval_seconds?|

Required check-in interval (inverse mode) in seconds

Formatint64

Range0 <= value

description?|

Optional description

escalation?array<>

Escalation ladder for inverse-mode dead-man switches

mode?null|

name*string

Human-readable name for the ceremony

on_complete?null|

on_dispute?null|

ordering?array<string>|

Optional ordering constraint over part ids

parts*array<>

Named parts, each bound to an assigned actor

quorum?null|

window_ms*integer

Simultaneity window in milliseconds

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rituals/definitions" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "parts": [      {        "assigned_to": "string",        "part_id": "string"      }    ],    "window_ms": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "name": "string",  "ritual_def_id": "string",  "version": 0}

GET/api/v1/rituals/definitions/{def_id}

Get_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

def_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rituals/definitions/string"

{  "arm_ttl_seconds": 0,  "checkin_interval_seconds": 0,  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "escalation": [    {      "action": "notify",      "after_missed_seconds": 0,      "pubsub_channel": "string",      "webhook_ids": [        "string"      ]    }  ],  "mode": "forward",  "name": "string",  "on_complete": null,  "on_dispute": "none",  "ordering": [    "string"  ],  "parts": [    {      "actor_type": "user",      "assigned_to": "string",      "part_id": "string"    }  ],  "quorum": {    "of": 0,    "required": 0  },  "ritual_def_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0,  "window_ms": 0}

GET/api/v1/rituals/{def_id}/analytics

Analytics

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

def_id*string

Query Parameters

sample_size?integer

Maximum number of recent terminal attempts to sample

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rituals/string/analytics"

{  "completed": 0,  "failed": 0,  "lateness_leaders": [    {      "near_miss_count": 0,      "part_id": "string"    }  ],  "median_spread_ms": 0,  "ritual_def_id": "string",  "success_rate": 0.1,  "total_attempts": 0}

POST/api/v1/rituals/{def_id}/arm

Arm_ritual

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

def_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

rehearsal?boolean

Run the full detection pipeline but suppress completion side effects

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/rituals/string/arm" \  -H "Content-Type: application/json" \  -d '{}'

{  "armed_at_ms": 0,  "attempt_id": "string",  "deadline_ms": 0,  "rehearsal": true,  "ritual_def_id": "string",  "status": "armed"}

GET/api/v1/rituals/{def_id}/history

List_history

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

def_id*string

Query Parameters

filter?

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: armed_at_ms. Default: -armed_at_ms.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/rituals/string/history"

{  "attempts": [    {      "armed_at_ms": 0,      "attempt_id": "string",      "deadline_ms": 0,      "performances": [        {          "part_id": "string",          "performed_by": "string",          "server_ts_ms": 0        }      ],      "rehearsal": true,      "report": null,      "ritual_def_id": "string",      "status": "armed"    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

Ritual

200application/json

403

404

503

200application/json

400

403

404

409

503

200application/json

403

404

409

503

200application/json

400

403

404

409

503

200application/json

400

503

201application/json

400

403

503

200application/json

403

404

503

200application/json

403

404

503

201application/json

403

404

503

200application/json

400

403

404

503

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`