Send a test event

Sends a signed ping envelope straight to the endpoint (no retries, not recorded in deliveries) and reports what happened. Requires webhooks:manage.

POST/webhook-endpoints/{endpointId}/ping

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Path parameters

endpointIdstringrequired

Webhook endpoint id (`we_...`).

Responses

200Attempt result (a failing endpoint still returns 200 here).

deliveredboolean

http_statusinteger | null

The endpoint's HTTP status, when it answered.

errorstring | null

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

404No such resource.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X POST "https://api.tippage.com/v1/webhook-endpoints/string/ping" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/webhook-endpoints/string/ping", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://api.tippage.com/v1/webhook-endpoints/string/ping",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "delivered": true,
  "http_status": 0,
  "error": "string"
}