Skip to main content

Ping webhook

POST 
/v2/config/webhook/:webhookId/ping

This endpoint pings a webhook that was defined to trigger events to an external IT system. Use it to check that the payload URL answers.

The service sends a POST with an empty body to the payload URL. A ping carries no X-IGrant-Signature header, so the receiver cannot check its authenticity. The service does not record a ping as a webhook delivery.

The service answers with 200 for a reachable payload URL and for an unreachable one. Read the status field to tell the two apart.

Request​

Path Parameters

    webhookId stringrequired

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses​

The service completed the ping. The status field tells you if the payload URL answered.

Response Headers
    Schema
      responseStatusCode int32required

      HTTP status code that the payload URL sent. The value is 0 when the service could not reach the payload URL.

      responseStatusStr stringrequired

      HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.

      executionStartTimestamp stringrequired

      UTC time when the ping started.

      executionEndTimestamp stringrequired

      UTC time when the ping ended.

      status stringrequired

      Possible values: [completed, failed]

      Result of the ping. completed means the payload URL answered. failed means the service could not reach it.

      statusDescription stringrequired

      Reason for a failure. The value is an empty string when status is completed.

    Loading...
    Last updated on