Add people to an incident and page them.

POST

/incident/{incident_id}/participants

curl --request POST \
  --url https://api.siteqwality.com/incident/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "schedule_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "escalation_policy_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "role": "lead", "page": true }'

• Production

Send exactly one of user_id, schedule_id (whoever is on call now) or escalation_policy_id (its first level, as it would page now). A lead must be a user_id. Someone already on the incident keeps their role and is paged again when page is true. Participants are not billed responders. Returns every participant of the incident.

Authorizations

• bearer_auth

Parameters

Path Parameters

incident_id

required

string format: uuid

Incident identifier

Request Body ^required

Media type application/json

Exactly one of user_id, schedule_id and escalation_policy_id.

object

user_id

string | null format: uuid

schedule_id

Adds whoever is on call now.

string | null format: uuid

escalation_policy_id

Adds the first level’s users and on-call people.

string | null format: uuid

role

One of:

string

Defaults to responder; lead needs a user_id.

string

Allowed values: lead responder comms

null

null

page

Page each added user through their notification rules (default true).

boolean | null

Responses

200

The incident’s participants

Media type application/json

Array<object>

object

user_id

required

string format: uuid

role

required

string

Allowed values: lead responder comms

added_by

Who added them; the acknowledger for an automatic lead.

string | null format: uuid

added_at

required

string format: date-time

paged_at

When they were paged on being added; null when they were not.

string | null format: date-time

Example

[
  {
    "role": "lead"
  }
]

400

Not exactly one of user_id, schedule_id and escalation_policy_id, a lead that is not a user_id, or paging an incident without a service

401

Missing or invalid authentication

404

Incident, user, schedule or escalation policy not found

409

The incident was merged, a resolved incident cannot page, or nobody is on call; data holds its current state

422

Unknown role

500

Internal server error