Chilkat Online Tools

Xojo / easybill REST API / Fetch WebHooks list

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("limit","<integer>")
success = queryParams.UpdateString("page","<integer>")

http.SetRequestHeader "Authorization","{{apiKey}}"
http.SetRequestHeader "Accept","application/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/webhooks",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

// 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

Dim url As String
Dim content_type As String
Dim secret As String
Dim description As String
Dim id As String
Dim is_active As Boolean
Dim Date As String
Dim Code As String
Dim Response As String
Dim j As Int32
Dim count_j As Int32
Dim strVal As String

Dim page As String
page = jResp.StringOf("page")
Dim pages As String
pages = jResp.StringOf("pages")
Dim limit As String
limit = jResp.StringOf("limit")
Dim total As String
total = jResp.StringOf("total")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("items")
While i < count_i
    jResp.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.J = j
        strVal = jResp.StringOf("items[i].events[j]")
        j = j + 1
    Wend
    i = i + 1
Wend

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": ""
    }
  ]
}