---
title: "Service: /clients/{client}/webhooks/{webhook}/ping [GET]"
source: https://dev.pageseeder.com/api/services/webhook-ping_get.html
description: "API endpoint to sends a ping request to a specific webhook to verify the client app is correctly configured to receive webhook events. The client must respond with HTTP 200/204 and the matching X-PS-Secret header to activate the webhook."
last_updated: 2026-09-08T11:45:30+10:00
document_type: api_endpoint
operation_id: webhook-GET
resource_id: webhook
path_template: /clients/{client}/webhooks/{webhook}/ping
http_method: GET
api_category: webhook
implementation_version: 6.2008
api_since: 5.9500
deprecated_since: null
obsolete_since: null
api_support: experimental
cache_control: null
generated_at: 2026-09-02
tokens: ~540
---

# /clients/\{client\}/webhooks/\{webhook\}/ping \[GET\]

## Description

Send ping request for a specific [webhook](../../reference/glossary/webhook.md).

The purpose of this service is to ensure that the [client app](../../reference/glossary/oauth_client.md) is configured correctly to receive events posted by the Webhook.

### Ping request

When this service is invoked, PageSeeder uses the webhooks to post a `webhook.ping` event to the URL defined on that webhook client.

For example:

```text
POST /your/endpoint
Host: app.example.org
Content-Type: application/json; charset=UTF-8
X-PS-Secret: 64f99fe53a
{
  "webhook": {
    "id": 456,
    "name": "sample"
  },
  "webevents": [
     {
       "id": "456.1108030026650199",
       "datetime": "2022-08-02T13:45:12+10:00",
       "type": "webhook.ping"
     }
  ]
}
```

> **Note:** If you have defined a Webhook secret, the request also includes the `X-PS-Signature` HTTP header.

## Ping response

To confirm that it is ready to receive webhook events from PageSeeder, the client app must return a successful HTTP response, such as [200 OK](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200) or [204 No Content](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204), that includes the HTTP header `X-PS-Secret` set to the same value as was sent in the POST request header. Other response headers and body content are ignored.

For example:

```text
HTTP/2 204 No Content
Date: Tue, 02 Aug 2022 03:41:40 GMT
Server: SampleApp
X-PS-Secret: 64f99fe53a
```

**When that is the case, the webhook status changes from “pending” to “active”. This confirms that the client wishes to receive webhook POST requests from PageSeeder and helps guard against PageSeeder sending unwanted or SPAM requests.**

## Parameters

No parameters required.

## Permission

This service requires administrator.

## Response

```xml

<ping-sent />
```

## Error Handling

| 0x170A | If the HTTP code returned by the webhook is not 200 |
| --- | --- |
| 0x170B | If the ping header returned by the webhook is missing or invalid |
| 0x170C | If there was any other error when connecting to the webhook client |