Ping webhook
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
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
webhooks:test
Path parameters
webhookId stringrequiredThe
idof the webhook, from Create webhook or List all webhooks.Example:
"68a1f2c3d4e5f6a7b8c9d0e1"
Response
The result of the ping.
responseStatus Code integer<int32>The HTTP status code of the answer of the payload URL.
0when it did not answer.Example:
200responseStatus Str stringThe HTTP status line of the answer, for example
200 OK. An empty string when the payload URL did not answer.Example:
"200 OK"executionStart Timestamp stringWhen the ping started: Unix time in seconds, as a string.
Example:
"1754745764"executionEnd Timestamp stringWhen the ping ended: Unix time in seconds, as a string.
Example:
"1754745765"statusenum<string>completed: the payload URL answered, with any status code (readresponseStatusCode).failed: it did not answer, for example a connection, DNS or TLS error; readstatusDescription.Available options:
completed,failedExample:
"completed"statusDescription stringThe error when
statusisfailed. An empty string when it iscompleted.