---
title: "Test a webhook subscription"
method: POST
path: "/webhooks/{webhook_id}/test"
tags: ["Webhooks"]
---

# Test a webhook subscription

`POST /webhooks/{webhook_id}/test`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/webhooks/{webhook_id}/test`
- Auth: API key in header `API-Key`

Sends a signed synthetic payload using the saved subscription configuration.

Required scope: `webhooks:write`

## Path parameters

- `webhook_id` string, uuid, required

## Request body

- TestWebhookSubscriptionRequest
  - `event_type` string, required

## Response `200`

The request has succeeded.

- WebhookTestResult
  - `delivery_id` string, required
  - `success` boolean, required
  - `response_code` integer
  - `response_body` string
  - `error_message` string
  - `duration_ms` integer, required
  - `attempted_at` string, date-time, required

## Other responses

- `400`: The server could not understand the request due to invalid syntax.
- `401`: Access is unauthorized.
- `402`: Client error
- `403`: Access is forbidden.
- `404`: The server cannot find the requested resource.
- `422`: Client error
- `429`: Client error
- `500`: Server error
- `501`: Server error

---

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