Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Update an alert channel

Updates an alert channel's display name, scope or type-specific configuration.

PUT https://app.upfour.io/v1/notification_channels/{channelID}
PUT https://app.upfour.io/v1/notification_channels/{channelID}

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs notification_channel.write.
Path
Body
More fields4
scope Changes the scope together with client_id or team_id; leave all three out to keep it.

1 more field is only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope notification_channel.write stable returns 200

Parameters

FieldTypeDescription
channelID required uuid path parameter

Body

application/json required 5 fields

All other fields56 fields
client_iduuid · nullable
configobject

Only the keys of the channel's type are read. Secret keys left empty or sent back as the masked value keep the stored secret; an empty object or null keeps the whole config.

Possible shapes 16

email · object

type email.

FieldTypeDescription
email required string Recipient email address. In the app: Email address
language optional string one ofende"" Language of the notifications; empty inherits the company language.
send_individually optional boolean Skip the digest for this channel and send every notification on its own. In the app: Send every notice on its own

sms · object

type sms (Twilio).

FieldTypeDescription
account_sid required string Twilio Account SID.
auth_token required string Twilio Auth Token of that region and account. Secret.
from_number required string pattern ^\+[0-9]{7,15}$ Sender number in E.164 format.
to_number required string pattern ^\+[0-9]{7,15}$ Recipient number in E.164 format.
language optional string one ofende"" Language of the notifications; empty inherits the company language.
region optional string one ofus1ie1"" Twilio region of the account; empty means us1. ie1 does not take numbers starting with +1.

voice · object

type voice (Twilio phone call).

FieldTypeDescription
account_sid required string pattern ^AC[0-9a-fA-F]{32}$ Twilio Account SID (AC followed by 32 hex digits).
auth_token required string min length 16 Twilio Auth Token of that region and account, without surrounding spaces. Secret.
from_number required string pattern ^\+[0-9]{7,15}$ Sender number in E.164 format.
to_number required string pattern ^\+[0-9]{7,15}$ Recipient number in E.164 format.
language optional string one ofende"" Language of the notifications; empty inherits the company language.
region optional string one ofus1ie1au1"" Twilio region of the account; empty means us1.

webhook · object

type webhook.

FieldTypeDescription
url required string (uri) pattern ^https:// https URL that receives the alert. In the app: Webhook URL
secret optional string Signs the request in X-Up4-Signature when set. Secret. In the app: Signing secret

slack · object

type slack.

FieldTypeDescription
webhook_url required string (uri) pattern ^https:// Incoming-webhook URL; the host must end in slack.com. Secret. In the app: Slack Webhook URL
channel optional string Channel to post to, if the webhook allows overriding it.
language optional string one ofende"" Language of the notifications; empty inherits the company language.

telegram · object

type telegram.

FieldTypeDescription
bot_token required string Token of the Telegram bot. Secret. In the app: Bot Token
chat_id required string Chat, group or channel ID the bot posts to. In the app: Chat ID
language optional string one ofende"" Language of the notifications; empty inherits the company language.

msteams · object

type msteams.

FieldTypeDescription
webhook_url required string (uri) pattern ^https:// Incoming-webhook URL of the Teams channel. Secret.
language optional string one ofende"" Language of the notifications; empty inherits the company language.

discord · object

type discord.

FieldTypeDescription
webhook_url required string (uri) pattern ^https:// Discord webhook URL. Secret.
language optional string one ofende"" Language of the notifications; empty inherits the company language.

pagerduty · object

type pagerduty.

FieldTypeDescription
routing_key required string Integration (routing) key of the PagerDuty service. Secret. In the app: Routing Key

zapier · object

type zapier.

FieldTypeDescription
webhook_url required string (uri) pattern ^https:// Zapier catch-hook URL. Secret.

datadog · object

type datadog.

FieldTypeDescription
api_key required string Datadog API key. Secret.
region optional string one ofus1eu1us3us5ap1"" Datadog site; empty means us1.

newrelic · object

type newrelic.

FieldTypeDescription
account_id required string New Relic account ID.
license_key required string New Relic license key. Secret.
region optional string one ofuseu"" New Relic data centre; empty means us.

jira · object

type jira.

FieldTypeDescription
api_token required string Jira API token. Secret.
base_url required string (uri) pattern ^https:// https URL of the Jira site.
email required string Account email of the API token.
issue_type required string Issue type to create, e.g. Bug, Task or Story.
project_key required string pattern ^[A-Z][A-Z0-9_]{0,19}$ Key of the project that receives the issues.
language optional string one ofende"" Language of the notifications; empty inherits the company language.

grafana · object

type grafana.

FieldTypeDescription
webhook_url required string (uri) pattern ^https?:// Grafana webhook URL, http or https. Secret.

ntfy · object

type ntfy.

FieldTypeDescription
topic required string pattern ^[-_A-Za-z0-9]{1,64}$ Topic to publish to.
access_token optional string Access token of a protected topic. Secret.
language optional string one ofende"" Language of the notifications; empty inherits the company language.
priority optional string min, low, default, high, max, urgent or 1 to 5.
server_url optional string (uri) pattern ^https:// HTTPS origin of the ntfy server without credentials, query or fragment; empty means https://ntfy.sh.

pushover · object

type pushover.

FieldTypeDescription
app_token required string pattern ^[A-Za-z0-9]{30}$ 30-character Pushover application token. Secret.
user_key required string pattern ^[A-Za-z0-9]{30}$ 30-character Pushover user or group key. Secret.
device optional string Device name to send to; empty reaches every device.
language optional string one ofende"" Language of the notifications; empty inherits the company language.
priority optional integer -2–1 Pushover priority from -2 to 1; emergency priority is not supported.
namestring

A new display name; empty keeps the current one.

In the app: Name
scopestring · nullable

Changes the scope together with client_id or team_id; leave all three out to keep it.

organizationclientteam
team_iduuid · nullable

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data NotificationChannelResponse
NotificationChannelResponse · 17 fields
FieldTypeDescription
config object free-form keys The keys of the channel's type as sent on create. Secret values (auth_token, secret, webhook_url, bot_token, routing_key, api_key, license_key, api_token, app_token, user_key, access_token) are masked: ****** followed by their last four characters when longer than eight characters, otherwise only ******.
created_at string (date-time)
id uuid
monitor_count integer Monitors that route to this channel; 0 means nothing uses it. Only filled in the list.
name string
scope string one oforganizationclientteam
type string one ofemailsmsvoicewebhookslacktelegrammsteamsdiscordpagerdutyzapierdatadognewrelicjiragrafanantfypushover
updated_at string (date-time)
user_id uuid
client_id uuid
last_delivery_at string (date-time) Last successful delivery. Filled in the list.
last_failure_at string (date-time) Last failed delivery attempt. Filled in the list.
last_failure_reason string
last_voice_at string (date-time)
last_voice_status string Status of the last phone call, voice channels only. Filled in the list.
organization_id uuid Company the channel belongs to.
team_id uuid

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.