Ping Hook

GET /hooks/{hook_id}/ping

Ping webhook url to verify connectivity.

Roles

Users with the following roles may access this endoint:

Admin
Dispatcher

Request

GET /hooks/{hook_id}/ping/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Path Parameters

hook_id Integer, Required

Webhook identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel for more details.

Authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

  • Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
  • No longer than 256 characters.
  • At least 1 characters long.

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body

note

No request body

Response

Response Headers

Refer to WebhookPingResponseHeadersModel for more details.

x-cro-signature String

HMAC message signature.

  • Matches ^\s[a-zA-Z0-9\/+=]{11,270}\s$

x-request-id String, Conditional

Request identifier.

  • Valid UUID.

Response Body

Refer to WebhookPingResultModel for more details.

delivery_id String

Hook execution identifier.

  • Valid UUID.

http_status Integer

HTTP status return code.

  • Valid HTTP status code 1xx-5xx or -1. Status -1 means the HTTP call did not succeed/complete.

message String

Description of ping result.

Code Samples

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/hooks/{hook_id}/ping