---
title: "Test Webhook"
method: POST
path: "/api/v2/webhooks/test"
tags: ["Webhooks"]
---

# Test Webhook

`POST /api/v2/webhooks/test`

Tests a new or existing webhook.

When testing an existing webhook, the existing webhook data will be attached automatically as part of the outbound test request.
The data includes the request format, http method, authentication method (only if same type and add_position are attached), and signing secret.
The request payload data will overwrite existing webhook data in the outbound test request.

## Query parameters

- `webhook_id` string

## Request body

- WebhookTestRequest
  - `webhook` object, required — Webhook configuration for testing
    - `endpoint` string, required — The test endpoint URL
    - `http_method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
    - `request_format` 'json' | 'xml' | 'form_encoded'
    - `authentication` union
      - BasicAuthAuthentication — Basic authentication configuration
        - `type` 'basic_auth', required
        - `data` object
          - `username` string, required — Username for basic authentication
          - `password` string — Password for basic authentication
      - BearerTokenAuthentication — Bearer token authentication configuration
        - `type` 'bearer_token', required
        - `data` object
          - `token` string — Bearer token for authentication
      - ApiKeyAuthentication — API key authentication configuration
        - `type` 'api_key', required
        - `data` object
          - `name` string, required — Name of the API key parameter
          - `value` string — Value of the API key
        - `add_position` 'header' | 'query_string', required — Where to add the API key (header or query string)
    - `custom_headers` object

## Response `200`

Test completed successfully

- WebhookTestResponse
  - `test` object
    - `status` string — Test status (e.g., "success", "failed")
    - `message` string — Test result message
    - `response_code` integer — HTTP response code from the test endpoint
    - `response_body` string — Response body from the test endpoint

## Other responses

- `400` — Bad Request

## Changes

> 29 revisions in range; 1 not diffed.

- **2026-05-11** `a67ea66f0a52` — 3 info
  - the request property `webhook/authentication/oneOf[#/components/schemas/ApiKeyAuthentication]/data` became optional
  - the request property `webhook/authentication/oneOf[#/components/schemas/BasicAuthAuthentication]/data` became optional
  - the request property `webhook/authentication/oneOf[#/components/schemas/BearerTokenAuthentication]/data` became optional
- **2025-06-12** `9eac011b0efd` — 1 breaking, 1 info
  - removed `#/components/schemas/BasicAuthAuthentication, #/components/schemas/BearerTokenAuthentication, #/components/schemas/ApiKeyAuthentication` from the `webhook/authentication` request property `anyOf` list
  - added `#/components/schemas/BasicAuthAuthentication, #/components/schemas/BearerTokenAuthentication, #/components/schemas/ApiKeyAuthentication` to the `webhook/authentication` request property `oneOf` list
- **2025-06-12** `e93a5ab6e2a5` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/webhooks/test/post.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)