---
title: "Send a synthetic test webhook event"
method: GET
path: "/v1/projectId/{projectId}/test-webhook"
tags: ["Sending Setup"]
---

# Send a synthetic test webhook event

`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

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.

## Path parameters

- `projectId` string, required

## Query parameters

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

## Response `200`

OK

- object
  - `status` integer
  - `result` TestWebhookResult
    - `success` boolean

## Other responses

- `400`: Invalid request body or query - every violation found (missing/invalid/unexpected fields) is reported in one response, semicolon-separated, not just the first one hit.
- `403`: Missing or invalid API key
- `405`: The operation is blocked by a business rule (e.g. the resource is still in use)

---

[API](https://skmtc.dev/bluefox/apis/bluefox-email-public-api.md) · [All operations](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/revisions/fa1a0a835c7f?raw)
