Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

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_... or tpat_...) · headerrequired

A TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Path parameters
endpointIdstringrequired

Webhook endpoint id (we_...).

Responses
200

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

deliveredboolean
http_statusinteger | null

The endpoint's HTTP status, when it answered.

errorstring | null
401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

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

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring
404

No such resource.

errorstringrequired

Human-readable message.

codestring

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

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Parameters
Request
curl -X POST 'https://api.tippage.com/v1/webhook-endpoints/string/ping' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "delivered": true,
  "http_status": 0,
  "error": "string"
}