---
title: "Sends a signed test delivery to a webhook endpoint."
method: POST
path: "/api/webhooks/{uuid}/test"
tags: ["webhooks"]
---

# Sends a signed test delivery to a webhook endpoint.

`POST /api/webhooks/{uuid}/test`

## Request

- Base URL: `https://api.pricklymails.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pricklymails.com/api/webhooks/{uuid}/test`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `uuid` string, required

## Response `200`

The test-fire outcome.

- TestWebhookResponse: `POST /api/webhooks/{uuid}/test` response body: the outcome of the single test-fire attempt.
  - `delivered` boolean, required: `true` when the endpoint answered with a 2xx status.
  - `error` string, nullable: A transport error message, or a description of the non-2xx status, `None` on success.
  - `status_code` integer, nullable: The HTTP status the endpoint returned, `None` on a transport-level failure.

## Other responses

- `400`: Malformed uuid.
- `401`: Missing or invalid API key, session token, or agent token.
- `403`: The key or agent token lacks the `webhooks:update` scope.
- `404`: No endpoint with that uuid owned by the caller.

---

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