Webhooks

List webhooks

List the webhook endpoints registered on this account. Use this to show the user where Village is currently sending their data, to find a webhook's id before updating or deleting it, or to check whether one is paused. Each entry gives the delivery url, the event_filter it listens to (null means every event type), is_active, and has_secret. Supports pagination (cursor, limit), filtering by is_active, and a substring search over url and description. The HMAC signing secret is never returned.

get/v2/webhooks

Request

Base URL: https://api.village.ai
URL: https://api.village.ai/v2/webhooks
Auth: HTTP bearer

Query parameters

cursorstring

Opaque cursor for pagination (from the previous response)

Example:eyJvZmZzZXQiOjI1LCJsaW1pdCI6MjV9

limitstring

Number of webhooks per page (max 100)

Example:25

is_active'true' | 'false'

Filter by active state. Omit to return both active and paused webhooks.

Example:true

searchstring

Substring match against the webhook URL or description

Example:example.com

Response

Webhooks retrieved successfully

Example response

{
  "data": [
    {
      "id": "MLVEUadsfgzdsafsc10q5g%3D%3D!vNnNM",
      "event_filter": [
        "new_connection"
      ]
    }
  ],
  "pagination": {
    "cursor": "eyJpZCI6IjEyMzQ1In0",
    "has_next_page": true,
    "count": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.