Webhook event

`ping`

Sent by POST /v1/webhook_endpoints/{id}/ping and by the dashboard's "Send test event" button. data.object is {"object": "ping", "endpoint": "we_…"}.

Type: ping
The object it carries: ping
Subscribe with: ping or *

Example payload

The body of the request your endpoint receives, shown here over several lines. On the wire it is compact JSON; check its signature over the bytes exactly as they arrive.

Example payload

{
  "id": "evt_7yyj6q58ddpkwemn3rgsedr0",
  "object": "event",
  "livemode": true,
  "created": "2026-10-12T12:00:00.000Z",
  "type": "ping",
  "api_version": "2026-10-11",
  "data": {
    "object": {
      "object": "ping",
      "endpoint": "we_tx7j2vmn3r2px2vpwbtz5h7b"
    }
  },
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "pending_webhooks": 1
}

Fields of data.object

Fields of data.object in ping
Field	In this example
`object`	`"ping"`
`endpoint`	`"we_tx7j2vmn3r2px2vpwbtz5h7b"`

This object exists only in this event. This event carries no data.previous_attributes.

Endpoints behind it

The call that sends it:

POSTSend a test event/v1/webhook_endpoints/{id}/ping

Other calls that change webhook endpoints. An event is also sent when a payer, the network, a timer or a person in the dashboard causes the change; the sentence above says which.