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

Breaking Changes

No breaking changes.

Request

Sample Request

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

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Allow: GET
Content-Length: 111
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:45:52 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-Cro-Signature: sha1=2cc2d32656e50f550936a6f14383b1383105a1b0
X-REQUEST-ID: e854d9af-6d40-4188-9d73-fc44111a2335

{
"delivery_id": "c86fefc0-cbb4-4c72-a530-4f80d09c877e",
"http_status": 200,
"message": "No exceptions raised."
}

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-api-version String, Optional

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

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-api-version String

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

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

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

Python

import requests, json

response = requests.get(
  'http://localhost:8003/hooks/{hook_id}/ping',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json',
    'x-tenant-id': '{your-tenant-id}'
  },
  parameters={
  }
)
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/hooks/{hook_id}/ping";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        string json = client.DownloadString(url);
        Console.WriteLine(json);
    }
}
}