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
Responses
- 200
- 401
- 404
- 500
The service completed the ping. The status field tells you if the payload URL answered.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
HTTP status code that the payload URL sent. The value is 0 when the service could not reach the payload URL.
HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.
UTC time when the ping started.
UTC time when the ping ended.
Possible values: [completed, failed]
Result of the ping. completed means the payload URL answered. failed means the service could not reach it.
Reason for a failure. The value is an empty string when status is completed.
{
"responseStatusCode": 200,
"responseStatusStr": "200 OK",
"executionStartTimestamp": "string",
"executionEndTimestamp": "string",
"status": "completed",
"statusDescription": "string"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Resource not found
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Internal server error
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}