Fire a test delivery

Dispatches a synthetic webhook.test delivery to the subscription's URL (via the same DeliverWebhook job + per-attempt retries as production) so partners can verify their endpoint and HMAC verifier. Returns 400 if the subscription is inactive. The resulting partner_webhook_deliveries row is identical in shape to a production attempt — poll the deliveries endpoint ~60s later. No request body required.

Auth: Partner — authentication; findCallerSubscription enforces bundle_id === 1 and scopes by partner_company_id (404 if not owned).

Rate limit: No rate limit.

Request

  • No body.

Response{ data: { data: {.} } } envelope (HTTP 200).

  • data.data.subscription_id (int)
  • data.data.status (string) — queued
  • data.data.note (string) — hint pointing to the deliveries endpoint

Path params

ParameterTypeRequiredNotes
webhookSubscriptionIdintegerRequiredDigits only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json