---
title: "Test webhook endpoint"
method: POST
path: "/v1/webhooks/test"
tags: ["Webhooks"]
---

# Test webhook endpoint

`POST /v1/webhooks/test`

Sends a test webhook to the specified URL and returns the result.

**Use case.** Verify your webhook endpoint is correctly configured before using it in production.

**Payload types:**
- `success` - simulates successful code retrieval with verification data
- `failed` - simulates failed code retrieval with error message

**Your endpoint must return HTTP 200** to indicate successful receipt.

**Testing tool.** Use https://webhook.site to get a temporary URL for testing.

**No persistence.** Test webhooks are not stored in delivery history.

## Request body

- object
  - `url` string, uri, required — Webhook endpoint URL. Must be a valid URL.
  - `type` 'success' | 'failed', required — Webhook payload type to send: `success` or `failed`.

## Response `200`

Result of webhook test request.

- object — Result of webhook test request.
  - `success` boolean, required — Whether the webhook was delivered successfully (HTTP 200).
  - `http_code` integer — HTTP status code returned by your endpoint.
  - `response_time_ms` integer — Response time in milliseconds.
  - `response_body` string — Response body from your endpoint (truncated to 1000 characters).
  - `error` string — Error message if delivery failed.

---

[API](https://skmtc.net/getmytg/apis/get-my-tg-api.md) · [All operations](https://skmtc.net/getmytg/apis/get-my-tg-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getmytg/get-my-tg-api/versions/30f975c0d1e6/schema)