API ReferenceWebhooks

List webhook subscriptions

Markdown
GET/api/v3/webhook_subscriptions

Lists all webhook subscriptions for the authenticated project with pagination. Currently limited to one subscription per project.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Query Parameters

limitnullable number

Number of items per page, max allowed is 1000

cursorstring

Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/webhook_subscriptions"
{
  "items": [
    {
      "id": "string",
      "webhook_url": "string",
      "version": "V1",
      "enabled_events": [
        "string"
      ],
      "secret": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "next_cursor": "string",
  "total_pages": 0,
  "current_page": 0,
  "total_items": 0
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}