Get Webhook

Gets details of a webhook in an app.

GET /apps/{appId}/webhooks/{webhookId}

Get Webhook

cURL

curl --request GET \
  --url https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId} \
  --header 'key: <key>' \
  --header 'secret: <secret>'

import requests

url = "https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}"

headers = {
    "key": "<key>",
    "secret": "<secret>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {key: '<key>', secret: '<secret>'}};

fetch('https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "key: <key>",
    "secret: <secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("key", "<key>")
	req.Header.Add("secret", "<secret>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}")
  .header("key", "<key>")
  .header("secret", "<secret>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["key"] = '<key>'
request["secret"] = '<secret>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "data": {
        "id": "test_webhook201",
        "name": "test_webhook201",
        "webhookURL": "https://example.com/test",
        "createdAt": 1684141151,
        "updatedAt": 1684141151
      }
    }
  ]
}

For the complete error reference, see Error Guide.

Headers

key · string · required

Authorization Key

secret · string · required

Authorization Secret

X-Webhook-Version · integer

The "X-Webhook-Version" header is an optional integer property.When this header is omitted from the request, the system defaults to the legacy webhook, ensuring backward compatibility and seamless operation.Conversely, setting the value of this header to "2" indicates the preference for the new webhook implementation.

Path Parameters

appId · string · required

AppID in which the extension has to be enabled/disabled

webhookId · string · required

Id of the webhook

Response

200 - application/json

Get Webhook

data · object

Show child attributes