---
title: "Test a webhook endpoint"
method: POST
path: "/webhook-endpoints/{id}/test"
tags: ["Webhooks"]
---

# Test a webhook endpoint

`POST /webhook-endpoints/{id}/test`

## Request

- Base URL: `https://workflow.loopfour.ai/api/v1`
- URL: `https://workflow.loopfour.ai/api/v1/webhook-endpoints/{id}/test`
- Auth: API key in header `x-api-key`

Sends a test webhook to verify the endpoint.

## Path parameters

- `id` string, required

## Request body

- object
  - `eventType` 'workflow.started' | 'workflow.completed' | 'workflow.failed' | 'workflow.timeout' | 'workflow.checkpoint' | 'workflow.cancelled': Event type to simulate.

## Response `200`

Test result

- object
  - `success` unknown
  - `data` object
    - `success` boolean
    - `httpStatus` number, nullable
    - `responseBody` string, nullable
    - `eventId` string
    - `error` string, nullable

## Other responses

- `401`: Missing or invalid API key.
- `403`: Forbidden — insufficient permissions for this resource.
- `404`: Resource not found.

---

[API](https://skmtc.dev/loopfour/apis/loopfour-workflows-api.md) - [All operations](https://skmtc.dev/loopfour/apis/loopfour-workflows-api/llms.txt) - [OpenAPI document](https://skmtc.dev/loopfour/apis/loopfour-workflows-api/revisions/872822a3af00?raw)
