Sending Setup

Send a synthetic test webhook event

Fires a synthetic event of the given type at the project's configured webhook URL, to confirm it's reachable and correctly signed. 503 if the webhook endpoint itself rejects or errors on the test request.

get/v1/projectId/{projectId}/test-webhook

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/test-webhook
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

Query parameters

type'bounce' | 'complaint' | 'open' | 'click' | 'pause-subscription' | 'unsubscribe' | 'subscribe' | 'resubscribe' | 'sent' | 'failed' required

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.