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

# Test a webhook

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

## Request

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

Send one signed `ping` event to a webhook now and report how the receiver answered: delivered, or error as one of no answer, refused, timed out, TLS failed or HTTP <status>.

## Path parameters

- `id` string, required

## Response `200`

Done

- object
  - `delivered` boolean, required
  - `status` integer, nullable, required
  - `error` string, nullable, required

## Other responses

- `401`: The credential is missing or not valid.
- `413`: payload_too_large: the body is over 256 KB (2 MB for /v1/tools).
- `415`: unsupported_media_type: a body was sent without Content-Type: application/json.
- `429`: rate_limited: this credential is over its rate. Retry after the Retry-After header's seconds.
- `500`: internal: Ploti failed. Retry; if it keeps happening, contact support.
- `default`: Refused: nothing was done. The code says why and the links say where the person acts on it.

---

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