A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "slack",
"destination_hint": "<string>",
"description": "<string>",
"enabled": true,
"disabled_reason": "<string>",
"last_delivered_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Update an alert channel
Requires alerts:manage. enabled: false pauses it; enabled: true also clears whatever reason the sender recorded when it turned the channel off.
The kind is not editable, and the absence of that field is the decision: a channel whose kind changed is a different destination with the same delivery history hanging off it, and that history is what the screen reads to answer “is this thing working”. Registering a new one costs nothing.
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "slack",
"destination_hint": "<string>",
"description": "<string>",
"enabled": true,
"disabled_reason": "<string>",
"last_delivered_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
The alert channel's id. An id from another organization matches no row and answers 404.
Body
Response
Updated.
Not editable after registration: the delivery history hangs off the channel, and a channel whose kind changed is a different destination wearing another one's record.
slack, discord, email What may be shown in place of the destination: the host for a chat hook (hooks.slack.com), the address for an email. Never a fragment of the webhook path — that is the part of the credential with the entropy in it.
Your label. What tells two channels on one workspace apart, since the hint is only the host.
Why it is off when nobody turned it off — a destination the provider answered 410 or 404 for no longer exists, and we stop rather than retry into it. Empty for a channel you paused yourself.
null means nothing has ever gone out, which is the normal state on a healthy organization. It is also why the test send exists.