Replace a platform alert destination

Replaces a destination in place. The id is immutable, because the custody reference is
derived from it.

Omit the signing secret, or send the mask sentinel, to leave the sealed secret
untouched — which is what lets a console round-trip its form without asking the
operator to retype a secret they cannot see. Supplying a new value rotates it.

That holds while the endpoint is unchanged. Moving a webhook that HAS a

sealed secret to a different URL without supplying a new one is refused with
400: keeping the sealed secret would let it sign deliveries to a host it

was never issued for, and dropping it would silently un-sign a webhook whose receiver
is still verifying. A webhook with no sealed secret moves freely. To move a signed
one unsigned, delete the destination and declare it again without a secret.

Authorization: admin.platform.alerts.write.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

Declares or replaces a platform alert destination.

string
enum
required

Delivery channel.

Allowed:
string
enum
required

ALERT receives the fired catalogue; HEARTBEAT is the outbound dead man's switch, whose ABSENCE is the signal. HEARTBEAT is validated strictly for SSRF regardless of deployment type: a receiver on the internal network dies with the thing it exists to report on.

Allowed:
config
required

Per-channel configuration. Its channel field must equal the channel above; a mismatch is rejected rather than silently resolved, because either value could be the intended one and guessing produces a destination the operator did not ask for.

acceptedSeverities
array of strings, unique
required
length ≥ 1

Severities this destination accepts.

boolean
Defaults to true

Whether this destination is delivered to. Defaults to true.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json