On-Call API › Alerts
Acknowledge an alert
Marks the alert acknowledged by the caller. When the alert's escalation policy has an ack timeout the escalation pauses and resumes if the alert is still unresolved when it runs out; otherwise the escalation stops.
Acknowledging an alert that is already acknowledged succeeds and changes nothing. A resolved alert cannot be acknowledged. No request body.
Permission (API-key scope): oncall:alert:respond.
Authorization
bearerAuth(oncall:alert:respond)apiKeyHeader(oncall:alert:respond)
Parameters
Path parameters
idstring requiredThe alert's id.
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
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 alert with this id in your organization (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
409
The alert is already resolved (ALERT_RESOLVED).
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.
Example request
curl -X POST 'https://evohub.io/api/v1/alerts/9d4e2f1a-6b3c-4d8e-a7f9-0c1b2a3d4e5f/acknowledge' \
-H 'Authorization: Bearer <TOKEN>'