Chilkat Online Tools

Foxpro / Sunshine Conversations API / List Webhooks

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcTarget
LOCAL lcId
LOCAL lcVersion
LOCAL lcSecret
LOCAL lnIncludeFullUser
LOCAL lnIncludeFullSource
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
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.BasicAuth = 1
loHttp.Login = "username"
loHttp.Password = "password"

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
ENDIF

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

* {
*   "webhooks": [
*     {
*       "target": "http://example.com/callback",
*       "triggers": [
*         "conversation:read",
*         "conversation:message"
*       ],
*       "id": "5e554d2cac66fb73a3c01871",
*       "version": "v2",
*       "secret": "8564b3e6a8b20a4bdb68b05ce9bc5936",
*       "includeFullUser": false,
*       "includeFullSource": false
*     },
*     {
*       "target": "http://example.com/callback",
*       "triggers": [
*         "conversation:read",
*         "conversation:message"
*       ],
*       "id": "5e554d2cac66fb73a3c01871",
*       "version": "v2",
*       "secret": "8564b3e6a8b20a4bdb68b05ce9bc5936",
*       "includeFullUser": false,
*       "includeFullSource": false
*     }
*   ]
* }

* 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 = loJResp.SizeOfArray("webhooks")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcTarget = loJResp.StringOf("webhooks[i].target")
    lcId = loJResp.StringOf("webhooks[i].id")
    lcVersion = loJResp.StringOf("webhooks[i].version")
    lcSecret = loJResp.StringOf("webhooks[i].secret")
    lnIncludeFullUser = loJResp.BoolOf("webhooks[i].includeFullUser")
    lnIncludeFullSource = loJResp.BoolOf("webhooks[i].includeFullSource")
    j = 0
    lnCount_j = loJResp.SizeOfArray("webhooks[i].triggers")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcStrVal = loJResp.StringOf("webhooks[i].triggers[j]")
        j = j + 1
    ENDDO
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks

Postman Collection Item JSON

{
  "name": "List Webhooks",
  "_postman_id": "e26b4273-eac6-45b0-b422-94a66032e924",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId/webhooks",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "integrations",
        ":integrationId",
        "webhooks"
      ],
      "variable": [
        {
          "key": "integrationId"
        }
      ]
    },
    "description": "Lists all webhooks for a given Sunshine Conversations Connect integration or custom integration."
  },
  "response": [
    {
      "id": "07913ccc-e1de-4d52-8a75-1996f5ee1106",
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId",
            "webhooks"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "9b583b6f-3cf6-4262-bcf0-35f341f3be42",
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId",
            "webhooks"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"webhooks\": [\n  {\n   \"target\": \"http://example.com/callback\",\n   \"triggers\": [\n    \"conversation:read\",\n    \"conversation:message\"\n   ],\n   \"id\": \"5e554d2cac66fb73a3c01871\",\n   \"version\": \"v2\",\n   \"secret\": \"8564b3e6a8b20a4bdb68b05ce9bc5936\",\n   \"includeFullUser\": false,\n   \"includeFullSource\": false\n  },\n  {\n   \"target\": \"http://example.com/callback\",\n   \"triggers\": [\n    \"conversation:read\",\n    \"conversation:message\"\n   ],\n   \"id\": \"5e554d2cac66fb73a3c01871\",\n   \"version\": \"v2\",\n   \"secret\": \"8564b3e6a8b20a4bdb68b05ce9bc5936\",\n   \"includeFullUser\": false,\n   \"includeFullSource\": false\n  }\n ]\n}"
    },
    {
      "id": "b879b53a-38da-4d6c-b0ad-7a230406ee86",
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId/webhooks",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId",
            "webhooks"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}