Skip to main content
Webhooks

Ping webhook

POST/v4/config/platform/webhook/{webhookId}/ping

Checks that the payload URL of a webhook answers. The service sends one HTTP POST with an empty body to the payload URL, waits for the answer and returns its status. Use it after you create a webhook or change its payload URL.

A ping has no X-IGrant-Signature header and no event headers, so the receiver cannot check that it comes from the service. A ping is not a delivery: List webhook deliveries does not show it. A disabled webhook can be pinged too.

The answer is 200 whether the payload URL answered or not: read status and responseStatusCode.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:webhooks:test

Path parameters

Response

application/json

The result of the ping.

  • responseStatusCodeinteger<int32>

    The HTTP status code of the answer of the payload URL. 0 when it did not answer.

    Example:200

  • responseStatusStrstring

    The HTTP status line of the answer, for example 200 OK. An empty string when the payload URL did not answer.

    Example:"200 OK"

  • executionStartTimestampstring

    When the ping started: Unix time in seconds, as a string.

    Example:"1754745764"

  • executionEndTimestampstring

    When the ping ended: Unix time in seconds, as a string.

    Example:"1754745765"

  • statusenum<string>

    completed: the payload URL answered, with any status code (read responseStatusCode). failed: it did not answer, for example a connection, DNS or TLS error; read statusDescription.

    Available options:completed,failed

    Example:"completed"

  • statusDescriptionstring

    The error when status is failed. An empty string when it is completed.