Test an alert channel

Sends a test notification through the selected alert channel.

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

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

channelIDpath · requiredPart of the request path.

Headers

Idempotency-KeyheaderGenerated automatically when empty. How it works

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 Idempotency-Key supported returns 200

Parameters

Field	Type	Description
`channelID` required	uuid	path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data NotificationChannelTestResponse

NotificationChannelTestResponse · 1 fields

Field	Type	Description
`message`	string

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.
402	`billing_action_unavailable`	The Company's billing state does not allow this action. When: A metered or limited action while the billing state, such as paused or without credit, blocks it; details holds the action and billing_state. Fix: Top up the credit or change the plan, then retry.
502	`channel_test_failed`	The alert channel's provider could not deliver the test. When: Sending a test alert to a channel when the provider fails in a way that fits none of the other provider codes. Fix: Check the channel's address and settings, then test again.
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.
422	`provider_auth_rejected`	The alert channel's provider rejected the credentials. When: A test alert whose provider answered 401 or 403. Fix: Check the token, secret or account details of the channel.
422	`provider_rejected`	The alert channel's provider rejected the test. When: A test alert whose provider answered 400, 404, 405, 410 or 422. Fix: Check the channel's address and settings.
504	`provider_timeout`	The alert channel's provider did not answer in time. When: A test alert whose provider took too long to respond. Fix: Check the address and try again later.
422	`provider_unreachable`	The alert channel's address cannot be reached. When: A test alert to a host that does not resolve, refuses the connection, has an invalid URL or an invalid HTTPS certificate. Fix: Check the URL and its HTTPS certificate.
503	`quota_gate_unavailable`	The limit check itself failed, so the action was not carried out. When: The quota service could not decide while the request ran. Fix: Retry in a moment; nothing was changed.
403 / 429	`quota_limit_reached`	A usage or inventory limit of the Company was reached. When: Counters and concurrency limits answer 429 with Retry-After, inventory and capacity limits answer 403; details holds purpose, limit and window. Fix: On 429 wait Retry-After seconds; on 403 free something up, request a higher limit where details.raise_request is true, or buy an extension.
503	`test_unavailable`	Sending a test is not possible right now. When: A test alert request while the test sender cannot take it. Fix: Try again in a moment.

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

const res = await fetch("https://app.upfour.io/v1/notification_channels/00000000-0000-4000-8000-000000000001/test", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, }, }); console.log(res.status, await res.json());

import os import requests res = requests.post( "https://app.upfour.io/v1/notification_channels/00000000-0000-4000-8000-000000000001/test", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/notification_channels/00000000-0000-4000-8000-000000000001/test", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/notification_channels/00000000-0000-4000-8000-000000000001/test"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);