On-Call API › Alerts
Assign an alert
Assigns the alert to a person. It changes the assignee only, not the status.
The person must be a member of the organization who can respond to alerts
(holds oncall:alert:respond).
Permission (API-key scope): oncall:alert:respond.
Authorization
bearerAuth(oncall:alert:respond)apiKeyHeader(oncall:alert:respond)
Parameters
Path parameters
idstring requiredThe alert's id.
Request body required
assignee_idstring requiredThe user id of the new assignee.
Responses
200
The alert after the change.
dataAlert requiredShow Alert properties
idstring requiredorg_idstring requiredteam_idstringOwning team; empty for an organization-wide alert.escalation_policy_idstringEmpty when no policy pages for it.incident_idstringintegration_idstringThe integration that opened it; empty for alerts raised by hand or by another EvoHub product.fingerprintstringDeduplication key: while an alert with it is open, the same fingerprint retriggers it instead of opening another.titlestring requireddescriptionstringseverityAlertSeverity requiredstatusAlertStatus requiredsourcestring requiredWhere it came from: an integration kind such asprometheus,api,webhook, ormanual.labelsobjectannotationsobjectcurrent_escalation_stepintegerThe escalation step reached so far.acknowledged_bystringacknowledged_atstring (date-time)resolved_bystringresolved_atstring (date-time)snoozed_untilstring (date-time)snoozed_bystringassigned_tostringUser id of the assignee; empty when unassigned.notification_countintegerretrigger_countintegerHow many times the same fingerprint arrived again while it was open.created_atstring (date-time) requiredupdated_atstring (date-time) required
successboolean required
400
The body is not JSON (INVALID_BODY) or assignee_id is empty (VALIDATION_FAILED).
errorobject requiredcodestring requiredmessagestring requireddetailsarray of object requiredfieldstringmessagestring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
404
No such alert (NOT_FOUND), or the person is not a member of the organization (NOT_A_MEMBER).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
422
The person cannot respond to alerts: they do not hold oncall:alert:respond (CANNOT_RESPOND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
503
Whether the person may be paged could not be checked right now; nothing was changed (MEMBER_CHECK_UNAVAILABLE). Retry shortly.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
Example request
curl -X POST 'https://evohub.io/api/v1/alerts/9d4e2f1a-6b3c-4d8e-a7f9-0c1b2a3d4e5f/assign' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"assignee_id": "4c2a9e7b-1d3f-4a8c-b6e5-9f0a1b2c3d4e"
}'