# pingWebhookSubscription

mutation · in the family [System and integration setup](/reference/system-and-integration-setup/)

## What it does

Send a signed test delivery through the real webhook lane — prove your endpoint end to end.

Send ONE signed test delivery through the REAL webhook lane: ACTIVE subscriptions only (an inactive/suspended/doomed target refuses CONFLICT/FSM_TRANSITION_INVALID — the lane skips them by law); delivery is asynchronous at-least-once. OWNER-gated ENGINE-side. Template class (hand-derived v71).

## What happens

Delivery is asynchronous and at-least-once; watch your endpoint and the failure counters.

## Careful

OWNER-gated. Active subscriptions only — a paused or suspended webhook cannot deliver a ping.

## Who may call it

Capability area: **System and integration setup** — Registers, connections and the settings your systems run on.

- Owner
- System Administrator
- An API key whose scope allows `api:pingWebhookSubscription`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | yes | The id of the record. |

## Returns

[WebhookPingReceipt](/types/WebhookPingReceipt/) `WebhookPingReceipt!` — The pingWebhookSubscription receipt — accepted at EMIT; the delivery itself is asynchronous at-least-once through the real lane (watch your endpoint + the failure counters).

## Example request

```graphql
mutation ExamplePingWebhookSubscription($id: ID!) {
  pingWebhookSubscription(id: $id) {
    accepted
    pingId
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000"
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "pingWebhookSubscription": {
      "accepted": true,
      "pingId": "01900000-0000-7000-8000-36c312ac0000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))

## Used in

- [Send events to another system (webhooks)](/use-cases/send-events-to-another-system/)