---
title: "Test a webhook"
method: POST
path: "/v1/webhooks/{id}/test"
tags: ["webhooks"]
---

# Test a webhook

`POST /v1/webhooks/{id}/test`

## Request

- Base URL: `https://api.pomerado.ai`
- URL: `https://api.pomerado.ai/v1/webhooks/{id}/test`
- Auth: HTTP bearer

Send a signed test event to one of your webhooks and report how its receiver responded.

- It is sent now, whether the webhook is active or not.
- The event is {"id", "type": "webhook.test", "created_at", "data": {"webhook_id"}}.
- It is not retried and does not count toward turning the webhook off.

## Path parameters

- `id` string, required

## Response `200`

How the receiver answered

- WebhookTestResult
  - `delivered` boolean, required: The receiver answered with a 2xx
  - `status` integer, required: an integer
  - `failure` 'invalid_url' | 'forbidden_address' | 'timeout' | 'unreachable', nullable, required: Why no receiver answered: forbidden_address when the URL resolves to a private address, timeout after 10 seconds, or unreachable

## Other responses

- `400`: invalid_request
- `401`: unauthorized, reauthentication_required
- `403`: webhooks_unavailable, forbidden
- `404`: not_found
- `409`: webhook_secret_unreadable
- `500`: internal_error
- `503`: temporarily_unavailable

---

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