Fire a test delivery

Overview

Dispatches a synthetic webhook.test delivery to the subscription's URL (via the same DeliverWebhook job + per-attempt retries as production). This lets partners 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.

Prerequisites

• Obtain a bearer token with Partner access.
• Copy the webhookSubscriptionId for the subscription you want to test.

Base URL

Endpoint

POST /api/v1/partner/webhooks/{webhookSubscriptionId}/test

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.
• Who can call it: Partner tokens.
• findCallerSubscription enforces bundle_id === 1 and scopes by partner_company_id (404 if not owned).

Rate limit

• No rate limit.

Path parameters

Request body

Do not send a request body.

Response

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

200 Success · 200

{
  "data": {
    "data": {
      "subscription_id": 3,
      "status": "queued",
      "note": "Test event queued — check /partner/webhooks/3/deliveries within ~60s."
    }
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/webhooks/123/test" \
  --header 'Authorization: Bearer {{bearerToken}}' \
  --header 'Accept: application/json'