Send a webhook test

Accepts a webhook test request and returns the delivery record with its current status.

POST https://app.upfour.io/v1/webhook-subscriptions/{subscriptionID}/test

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

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs webhook.write.

Path

subscriptionIDpath · 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 webhook.write beta Idempotency-Key supported returns 202

Parameters

Field	Type	Description
`subscriptionID` required	uuid	path parameter

Returns

A successful request returns 202 with application/json.

Response fields 1 top-level fields

Field Type Description

data WebhookDelivery

WebhookDelivery · 12 fields

Field	Type	Description
`attempt`	integer	Number of the current attempt, at most 7.
`created_at`	string (date-time)
`event`	string
`id`	uuid
`payload_json`	any	The event as sent to the receiver.
`scheduled_at`	string (date-time)
`status`	string one of`pendingretryingdeliveredfailed`
`subscription_id`	uuid
`delivered_at`	string (date-time)
`next_retry_at`	string (date-time)
`response_body`	string	Never the receiver's answer, only a summary of the attempt: HTTP followed by the status code when the receiver answered (HTTP 200, HTTP 502), otherwise Delivery timed out, Delivery failed (for example a refused connection) or Delivery configuration or destination rejected.
`response_code`	integer

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`	This action is unavailable in the Company's billing state (`error.details.billing_state`), for example while credit is used up. 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. `billing_action_unavailable`: this action is not available in the Company's billing state (`error.details.billing_state`), for example while the credit is used up.
403	`permission_denied`	The credentials do not permit this action.
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`	The protection limit for this action is used up for now; `error.details` carries `purpose`, `limit`, `window` and `retry_after_seconds`, and the `Retry-After` header says when the same request can succeed. 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. `quota_limit_reached`: the protection limit of this action is used up for now. `error.details` carries `purpose`, `limit`, `window` and `retry_after_seconds`; the `Retry-After` header says when the same request can succeed.

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/webhook-subscriptions/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/webhook-subscriptions/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/webhook-subscriptions/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/webhook-subscriptions/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);

{ "data": { "attempt": 1, "created_at": "2026-10-27T09:00:00Z", "delivered_at": "2026-10-27T09:00:00Z", "event": "webhook.test", "id": "00000000-0000-4000-8000-000000000002", "payload_json": { "app_url": "http://example.com", "created_at": "2026-10-27T09:00:00Z", "data": { "message": "Webhook test" }, "id": "00000000-0000-4000-8000-000000000003", "payload_version": 2, "type": "webhook.test" }, "response_body": "HTTP 200", "response_code": 200, "scheduled_at": "2026-10-27T09:00:00Z", "status": "delivered", "subscription_id": "00000000-0000-4000-8000-000000000001" } }

{ "error": { "code": "billing_action_unavailable", "message": "This action is unavailable in the Company's billing state (error.details.billing_state), for example while credit is used up.", "request_id": "req_…" } }

{ "error": { "code": "quota_limit_reached", "message": "The protection limit for this action is used up for now; error.details carries purpose, limit, window and retry_after_seconds, and the Retry-After header says when the same request can succeed.", "request_id": "req_…" } }