Pause, resume or change an alert

Pause or resume an alert, change its events, email_mode or label, or rotate a webhook signing secret. Pass the id and only the fields to change. Examples: {"id": "alr_3f9a...", "status": "paused"}. {"id": "alr_3f9a...", "status": "active"} resumes an alert paused after webhook failures. {"id": "alr_3f9a...", "rotate_secret": true} returns a new secret once; the old one stops working at once. Returns {alert, secret?}.

patch/api/v1/alerts/{id}

Request

  • Base URL: https://invokely.ai
  • URL: https://invokely.ai/api/v1/alerts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key
    • none

Path parameters

idstring required

Request body

status'active' | 'paused'
eventsstring[]

What to be told about: "new_period" (a period not published before) and "revision" (a published value or its status changed). Default both.

email_mode'instant' | 'daily'
labelstring
rotate_secrettrue

Webhook alerts only: issue a new signing secret.

Response

{"data": {"alert", "secret"?}}

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.