Chilkat Online Tools

PureBasic / Sunshine Conversations API / List Webhooks

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(http, "password")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://domain.com/v2/apps/{{appId}}/integrations/:integrationId/webhooks",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

    target.s
    id.s
    version.s
    secret.s
    includeFullUser.i
    includeFullSource.i
    j.i
    count_j.i
    strVal.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"webhooks")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        target = CkJsonObject::ckStringOf(jResp,"webhooks[i].target")
        id = CkJsonObject::ckStringOf(jResp,"webhooks[i].id")
        version = CkJsonObject::ckStringOf(jResp,"webhooks[i].version")
        secret = CkJsonObject::ckStringOf(jResp,"webhooks[i].secret")
        includeFullUser = CkJsonObject::ckBoolOf(jResp,"webhooks[i].includeFullUser")
        includeFullSource = CkJsonObject::ckBoolOf(jResp,"webhooks[i].includeFullSource")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jResp,"webhooks[i].triggers")
        While j < count_j
            CkJsonObject::setCkJ(jResp, j)
            strVal = CkJsonObject::ckStringOf(jResp,"webhooks[i].triggers[j]")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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