Chilkat Online Tools

lianja / easybill REST API / Fetch WebHook

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.SetRequestHeader("Authorization","{{apiKey}}")
loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.easybill.de/rest/v1/webhooks/:id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

// {
//   "url": "<string>",
//   "content_type": "json",
//   "secret": "<string>",
//   "events": [
//     "position.update",
//     "document.create"
//   ],
//   "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

lcUrl = loJResp.StringOf("url")
lcContent_type = loJResp.StringOf("content_type")
lcSecret = loJResp.StringOf("secret")
lcDescription = loJResp.StringOf("description")
lcId = loJResp.StringOf("id")
llIs_active = loJResp.BoolOf("is_active")
lcDate = loJResp.StringOf("last_response.date")
lcCode = loJResp.StringOf("last_response.code")
lcResponse = loJResp.StringOf("last_response.response")
i = 0
lnCount_i = loJResp.SizeOfArray("events")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("events[i]")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-H "Authorization: {{apiKey}}"
	-H "Accept: application/json"
https://api.easybill.de/rest/v1/webhooks/:id

Postman Collection Item JSON

{
  "name": "Fetch WebHook",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/webhooks/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webhooks",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of WebHook"
        }
      ]
    }
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"url\": \"<string>\",\n  \"content_type\": \"json\",\n  \"secret\": \"<string>\",\n  \"events\": [\n    \"position.update\",\n    \"document.create\"\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}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/webhooks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}