# Send Test Event

`POST https://api.getprospect.com/v2/webhooks/{id}/test`

Sends a signed `webhook.test` event now and reports whether it was delivered, the HTTP status class and a coarse error code. Works on a paused or disabled webhook too, so a fixed receiver can be checked before re-activating it. 10 per webhook and 30 per workspace per minute. Free: no credits.

## Authentication

Pass your API key in the `x-api-key` header.

## Path parameters

- `id` (string, required): The webhook id (24 hex characters).

## Example request

```bash
curl --request POST \
  --url https://api.getprospect.com/v2/webhooks/{id}/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Response 200

The outcome of the test event.

```json
{
  "success": true,
  "data": {
    "delivered": true,
    "status_class": "2xx",
    "error_code": null
  },
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  }
}
```

## Response 400

Malformed webhook id (`VALIDATION_ERROR`, `payload.code: invalid_format`).

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "VALIDATION_ERROR",
      "message": "id must be a mongodb id",
      "payload": {
        "field": "id",
        "code": "invalid_format",
        "received_value": "123",
        "received_type": "string"
      }
    }
  ]
}
```

## Response 401

Missing, unknown or inactive credentials (`UNAUTHORIZED`).

## Response 404

No such webhook in this workspace (`NOT_FOUND`).

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "NOT_FOUND",
      "message": "Webhook not found."
    }
  ]
}
```

## Response 429

Over 10 test events per webhook or 30 per workspace in this minute (`RATE_LIMIT`); wait `Retry-After` seconds.

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "RATE_LIMIT",
      "message": "Too many test events; wait a minute."
    }
  ]
}
```

## Response 500

Unexpected server error.

## Response 503

Webhook delivery is not enabled for this workspace yet (`UNAVAILABLE`, `payload.code: temporarily_disabled`).

```json
{
  "success": false,
  "data": null,
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  },
  "errors": [
    {
      "name": "UNAVAILABLE",
      "message": "Webhook delivery is not enabled for this workspace yet.",
      "payload": {
        "code": "temporarily_disabled"
      }
    }
  ]
}
```