---
title: "Ping webhook"
method: POST
path: "/api/webhooks/{webhookId}/ping"
tags: ["Webhooks"]
---

# Ping webhook

`POST /api/webhooks/{webhookId}/ping`

Synchronously sends a signed test request to the registered webhook URL and returns the delivery outcome (status code and round-trip time). Works on disabled webhooks so connectivity can be verified before activation.

## Path parameters

- `webhookId` string, required

## Response `200`

The ping was attempted; the result describes the outcome.

- union
  - WebhookPingSuccess — The endpoint received the ping and responded with a 2xx status.
    - `responseStatusCode` integer, required — HTTP status code returned by the endpoint.
    - `responseTimeMs` integer, required — Round-trip time of the ping request, in milliseconds.
    - `type` 'success', required
  - WebhookPingHttpError — The endpoint was reached but responded with a non-2xx status.
    - `errorDetails` string, required — Human-readable description of the non-2xx response.
    - `responseStatusCode` integer, required — Non-2xx HTTP status code returned by the endpoint.
    - `responseTimeMs` integer, required — Round-trip time of the ping request, in milliseconds.
    - `type` 'httpError', required
  - WebhookPingUnreachable — The endpoint could not be reached (timeout, DNS failure, connection refused, or an over-cap response body).
    - `errorDetails` string, required — Human-readable description of why the endpoint was unreachable.
    - `responseTimeMs` integer, required — Time elapsed before the ping failed, in milliseconds.
    - `type` 'unreachable', required

## Other responses

- `401` — Unauthorized
- `403` — SignedAgreementRequiredException

---

[API](https://skmtc.net/muralpay/apis/mural-api.md) · [All operations](https://skmtc.net/muralpay/apis/mural-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/muralpay/mural-api/versions/437d277f5948/schema)