List webhooks

Returns a cursor-paginated list of webhook subscriptions.

GET /webhooks

Python

Python

import os
from datagrid_ai import Datagrid

client = Datagrid(
    api_key=os.environ.get("DATAGRID_API_KEY"),  # This is the default and can be omitted
)
page = client.webhooks.list()
page = page.data[0]
print(page.id)

200

{
  "object": "list",
  "data": [
    {
      "object": "webhook",
      "id": "<string>",
      "url": "<string>",
      "events": [
        "knowledge.processing.completed"
      ],
      "enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer · default: 50

The maximum number of webhook subscriptions to return.

Required range: 1 <= x <= 100

cursor · string

A pagination cursor returned by a previous list call.

Response

200

application/json

List of webhooks

object · enum<string> · required

Available options: list

data · object[] · required

An array containing webhook subscriptions for this page.

Show child attributes

has_more · boolean · required

Whether there are additional results available.

next_cursor · string | null · required

The cursor to supply to cursor to fetch the next page.