Chilkat Online Tools

TCL / New FreshBooks / List Webhook Callbacks

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "response": {
#     "result": {
#       "callbacks": [
#       ],
#       "page": 1,
#       "pages": 0,
#       "per_page": 15,
#       "total": 0
#     }
#   }
# }

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

set Page [CkJsonObject_IntOf $jResp "response.result.page"]
set Pages [CkJsonObject_IntOf $jResp "response.result.pages"]
set Per_page [CkJsonObject_IntOf $jResp "response.result.per_page"]
set Total [CkJsonObject_IntOf $jResp "response.result.total"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.result.callbacks"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks

Postman Collection Item JSON

{
  "name": "List Webhook Callbacks",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "events",
        "account",
        "{{accountId}}",
        "events",
        "callbacks"
      ]
    }
  },
  "response": [
    {
      "name": "List Webhook Callbacks",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "events",
            "account",
            "{{accountId}}",
            "events",
            "callbacks"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/vnd.api+json"
        },
        {
          "key": "X-Version",
          "value": "1905.1.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllXAAUBUlATGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4UBkhWURAEEBlDUhULRERQBxVNAVEOVABZW19BHRdcEl4UQQEBDFQACg9aUlMPEhBSQlgTFlJTEU5WT1IeUABSDggFAAVWCVUHUwVWUgMbTFdPGlcIBVNaVVVSV1UCAwNXVlpAHARZDktdaQ=="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "19"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346662"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:16:41 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Content-Length",
          "value": "94"
        },
        {
          "key": "Date",
          "value": "Wed, 08 May 2019 20:16:41 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"callbacks\": [],\n            \"page\": 1,\n            \"pages\": 0,\n            \"per_page\": 15,\n            \"total\": 0\n        }\n    }\n}"
    }
  ]
}