Skip to content
Site Qwality Site Qwality Site Qwality Docs

Create an escalation policy.

POST
/v1/escalation-policies
 
curl --request POST \
  --url https://api.siteqwality.com/v1/escalation-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "repeat_count": 1, "on_exhausted": "notify_owners", "escalate_to_policy_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string
<= 255 characters

Makes a retry safe: the same key and body within 24 hours returns the first response with Idempotent-Replayed: true. The same key with another body is refused with 422 idempotency_key_reused, and one still running with 409 idempotency_key_in_use.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
repeat_count

Times to run through every level again after the first pass, 0 to 20. Default 0: every level is paged once.

integer | null format: int32
on_exhausted
One of:

What happens when the repeats are used up, or no level reaches anyone. Default notify_owners.

string
Allowed values: notify_owners stop escalate_to_policy
escalate_to_policy_id

Required with on_exhausted: escalate_to_policy, and only allowed with it: another policy in this account.

string | null format: uuid

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The policy

Media type application/json
object
id
required
string format: uuid
account_id
required
string format: uuid
name
required
string
repeat_count
required

Times to run through every level again after the first pass.

integer format: int32
created_at
required
string format: date-time
levels
array | null
object
id
required
string format: uuid
escalation_policy_id
required
string format: uuid
level_number
required
integer format: int32
timeout_minutes
required
integer format: int32
target_user_ids
required
Array<string>
target_schedule_ids
required
Array<string>
created_at
required
string format: date-time
on_exhausted

What happens when the repeats are used up, or no level reaches anyone.

string
Allowed values: notify_owners stop escalate_to_policy
escalate_to_policy_id

The policy escalate_to_policy runs once; null otherwise.

string | null format: uuid
Example 
{
  "on_exhausted": "notify_owners"
}

Headers

Section titled “Headers ”
Idempotent-Replayed
string

true when this is the stored first response

400

Section titled “400 ”

Invalid request body

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

401

Section titled “401 ”

Missing or invalid credentials

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

403

Section titled “403 ”

The key or member may not do this, or lacks the scope it needs

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

404

Section titled “404 ”

escalate_to_policy_id is not a policy of this account

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

429

Section titled “429 ”

Too many requests; wait for the time in Retry-After

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

Privacy Cookie preferences