Chilkat Online Tools

phpExt / ShipEngine Walkthrough / List your webhooks

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$http->SetRequestHeader('API-Key','{{API_KEY}}');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.shipengine.com/v1/environment/webhooks',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jarrResp = new CkJsonArray();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// [
//   {
//     "webhook_id": "102349",
//     "url": "https://your-domain-here.com/some/path",
//     "event": "track"
//   }
// ]

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0;
$count_i = $jarrResp->get_Size();
while ($i < $count_i) {
    // json is a CkJsonObject
    $json = $jarrResp->ObjectAt($i);
    $webhook_id = $json->stringOf('webhook_id');
    $url = $json->stringOf('url');
    $v_event = $json->stringOf('event');

    $i = $i + 1;
}


?>

Curl Command

curl -X GET
	-H "API-Key: {{API_KEY}}"
https://api.shipengine.com/v1/environment/webhooks

Postman Collection Item JSON

{
  "name": "List your webhooks",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.shipengine.com/v1/environment/webhooks",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "environment",
        "webhooks"
      ]
    },
    "description": "This request lists all of the webhooks that you've setup, either via the API or the ShipEngine web dashboard."
  },
  "response": [
    {
      "name": "List your webhooks",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.shipengine.com/v1/environment/webhooks",
          "protocol": "https",
          "host": [
            "api",
            "shipengine",
            "com"
          ],
          "path": [
            "v1",
            "environment",
            "webhooks"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 18 Sep 2019 19:15:31 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "119"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "9a84eb30-c0bb-4942-bed9-fe9d051bd810"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"webhook_id\": \"102349\",\n        \"url\": \"https://your-domain-here.com/some/path\",\n        \"event\": \"track\"\n    }\n]"
    }
  ]
}