Chilkat Online Tools

Foxpro / ShipEngine Walkthrough / List your webhooks

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJarrResp
LOCAL lnRespStatusCode
LOCAL loJson
LOCAL lcWebhook_id
LOCAL lcUrl
LOCAL lcV_event
LOCAL i
LOCAL lnCount_i

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.SetRequestHeader("API-Key","{{API_KEY}}")

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.shipengine.com/v1/environment/webhooks",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJarrResp = CreateObject('Chilkat_9_5_0.JsonArray')
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = 0

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

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJarrResp
    CANCEL
ENDIF

* 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
lnCount_i = loJarrResp.Size
DO WHILE i < lnCount_i
    loJson = loJarrResp.ObjectAt(i)
    lcWebhook_id = loJson.StringOf("webhook_id")
    lcUrl = loJson.StringOf("url")
    lcV_event = loJson.StringOf("event")
    RELEASE loJson
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJarrResp

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