Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Test an alert plan

Creates a test run for one step or the full alert plan.

POST https://app.upfour.io/v1/escalation-policies/{policyID}/test
POST https://app.upfour.io/v1/escalation-policies/{policyID}/test

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs escalation_policy.write.
Path
Body
More fields2
mode step sends the step at step_position, full sends every step. Empty means step.
Headers

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope escalation_policy.write stable Idempotency-Key required returns 202

Parameters

FieldTypeDescription
policyID required uuid path parameter

Body

application/json optional 2 fields

All other fields2 fields
modestring

step sends the step at step_position, full sends every step. Empty means step.

stepfull
step_positioninteger

Zero-based position of the step to test; only used with mode step.

Returns

A successful request returns 202 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data EscalationPolicyTestRun
EscalationPolicyTestRun · 22 fields
FieldTypeDescription
created_at string (date-time)
id uuid
mode string one ofstepfull
policy_id uuid
status string one ofscheduledin_progressdeliveredfailed
steps EscalationPolicyTestStep[] · nullable
Each item · 16 fields
FieldTypeDescription
position integer Zero-based position of the step within the plan.
scheduled_at string (date-time)
status string one ofscheduledin_progressdeliveredfailed
targets EscalationPolicyTestTarget[] · nullable
Each item · 10 fields
FieldTypeDescription
attempts integer
channel_id uuid Nil UUID for a rotation that reached nobody.
channel_name string
channel_type string
status string one ofscheduledin_progressdeliveredfailedunresolved
error string
person_name string Who was on call for the rotation when the test started.
reason string one ofnobody_on_callno_alert_channelrotation_unavailable
rotation_id uuid The rotation this channel was reached through, if any.
rotation_name string
urgency string one ofhighlowsmsvoice
wait_seconds integer

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.