Skip to main content
GET
/
apps
/
{appId}
/
webhooks
List Webhooks
curl --request GET \
  --url https://apimgmt.cometchat.io/apps/{appId}/webhooks \
  --header 'key: <key>' \
  --header 'secret: <secret>'
{
  "data": [
    {
      "id": "test_webhook201",
      "name": "test_webhook201",
      "webhookURL": "https://example.com/test",
      "createdAt": 1684141151,
      "updatedAt": 1684141151
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.cometchat.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
perPage
integer
default:100

Number of webhooks to be fetched in a request. The default value is 100 and the maximum value is 1000.

​
searchKey
string

Searches for specified keyword in name

Response

200 - application/json

List Webhooks

​
data
object[]
​
meta
object