Chilkat Online Tools

Perl / easybill REST API / Fetch WebHooks list

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("limit","<integer>");
$queryParams->UpdateString("page","<integer>");

$http->SetRequestHeader("Authorization","{{apiKey}}");
$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://api.easybill.de/rest/v1/webhooks",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

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

# {
#   "page": "<integer>",
#   "pages": "<integer>",
#   "limit": "<integer>",
#   "total": "<integer>",
#   "items": [
#     {
#       "url": "<string>",
#       "content_type": "json",
#       "secret": "<string>",
#       "events": [
#         "document.update",
#         "document.deleted"
#       ],
#       "description": "<string>",
#       "id": "<long>",
#       "is_active": false,
#       "last_response": {
#         "date": "<dateTime>",
#         "code": "<integer>",
#         "response": "<string>"
#       }
#     },
#     {
#       "url": "<string>",
#       "content_type": "form",
#       "secret": "<string>",
#       "events": [
#         "contact.create",
#         "postbox.update"
#       ],
#       "description": "<string>",
#       "id": "<long>",
#       "is_active": false,
#       "last_response": {
#         "date": "<dateTime>",
#         "code": "<integer>",
#         "response": "<string>"
#       }
#     }
#   ]
# }

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

$page = $jResp->stringOf("page");
$pages = $jResp->stringOf("pages");
$limit = $jResp->stringOf("limit");
$total = $jResp->stringOf("total");
$i = 0;
$count_i = $jResp->SizeOfArray("items");
while ($i < $count_i) {
    $jResp->put_I($i);
    $url = $jResp->stringOf("items[i].url");
    $content_type = $jResp->stringOf("items[i].content_type");
    $secret = $jResp->stringOf("items[i].secret");
    $description = $jResp->stringOf("items[i].description");
    $id = $jResp->stringOf("items[i].id");
    $is_active = $jResp->BoolOf("items[i].is_active");
    $Date = $jResp->stringOf("items[i].last_response.date");
    $Code = $jResp->stringOf("items[i].last_response.code");
    $Response = $jResp->stringOf("items[i].last_response.response");
    $j = 0;
    $count_j = $jResp->SizeOfArray("items[i].events");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $strVal = $jResp->stringOf("items[i].events[j]");
        $j = $j + 1;
    }

    $i = $i + 1;
}

Curl Command

curl -G -d "limit=%3Cinteger%3E"
	-d "page=%3Cinteger%3E"
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/webhooks

Postman Collection Item JSON

{
  "name": "Fetch WebHooks list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/webhooks?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webhooks"
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Limited the result. Default is 100. Maximum can be 1000."
        },
        {
          "key": "page",
          "value": "<integer>",
          "description": "Set current Page. Default is 1."
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webhooks?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"page\": \"<integer>\",\n  \"pages\": \"<integer>\",\n  \"limit\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"items\": [\n    {\n      \"url\": \"<string>\",\n      \"content_type\": \"json\",\n      \"secret\": \"<string>\",\n      \"events\": [\n        \"document.update\",\n        \"document.deleted\"\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<long>\",\n      \"is_active\": false,\n      \"last_response\": {\n        \"date\": \"<dateTime>\",\n        \"code\": \"<integer>\",\n        \"response\": \"<string>\"\n      }\n    },\n    {\n      \"url\": \"<string>\",\n      \"content_type\": \"form\",\n      \"secret\": \"<string>\",\n      \"events\": [\n        \"contact.create\",\n        \"postbox.update\"\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<long>\",\n      \"is_active\": false,\n      \"last_response\": {\n        \"date\": \"<dateTime>\",\n        \"code\": \"<integer>\",\n        \"response\": \"<string>\"\n      }\n    }\n  ]\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webhooks?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Limited the result. Default is 100. Maximum can be 1000."
            },
            {
              "key": "page",
              "value": "<integer>",
              "description": "Set current Page. Default is 1."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}