List webhook events — Brigg developers

Access & visibility

Allow webhooks.ListWebhookEvents on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

webhook_idstringRequired

Identifier of the approved webhook subscription. After administrator approval, discover it with webhooks.ListWebhookSubscriptions using a credential with read access to every selected resource type. It is different from an event ID or delivery ID.

At least 1 character.

cursorstringOptional

Opaque next_cursor returned by this webhook's preceding page. Keep the same webhook and credential; omit it to start a new listing.

limitintegerOptional

Maximum number of results to return in this page. Continue with next_cursor when returned.

Default: 50. Range: 1 to 100.

sinceintegerOptional

Earliest event creation time to return, in Unix milliseconds. Recovery is limited to the 30-day retention window.

Minimum: 0.

Response

Returns 200 OK with a JSON body.

An empty items array means this page contains no matching visible results. Follow next_cursor when present.

itemsarray of Webhook eventRequired

Recoverable events for the selected webhook, within the 30-day retention window. Pass next_cursor as cursor to continue when a next cursor is returned.

Item fields

event_idstringRequired

Stable event identifier. Deduplicate notifications by this value, including retries and deliberate replays.

eventstringRequired

Event name. Supported values: meeting.completed, resource.created, resource.updated, resource.deleted. See the event reference for payloads and delivery contracts.

Allowed: "resource.created", "resource.updated", "resource.deleted".

version"v1"Required

Payload contract version used to serialize this event.

Always "v1".

occurred_atstringRequired

Event creation time in Unix milliseconds.

Format: date-time.

resourceobjectRequired

Affected record's type and ID; the event does not include the record's complete contents.

Nested fields

idstringRequired

Unique identifier. Use the value returned by a create or list operation.

typestringRequired

Type identifying which variant of this model applies.

versionstringRequired

Opaque resource revision. Events may arrive out of order.

changed_fieldsarray of stringOptional

Names of fields changed by an update, when supplied. Fetch the record to read its current values.

testtrueOptional

Whether this is a synthetic test event rather than a real resource change.

Always true.

next_cursorstringOptional

Continue this webhook's listing with this value as cursor. Omitted on the final page.

Pagination

Pass next_cursor as cursor on the next request, keeping the same query and acting identity. Stop when next_cursor is absent. Treat the cursor as opaque; never construct or edit it.

const query = {
  "webhook_id": "e_example"
};
let cursor;
do {
  const response = await fetch("https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ ...query, ...(cursor ? { cursor } : {}) }),
  });
  const page = await response.json();
  if (!response.ok) throw new Error(`${response.status}: ${page.message}`);
  for (const item of page.items) {
    console.log(item); // Process or upsert each result.
  }
  cursor = page.next_cursor;
} while (cursor);

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Receive and verify webhooks

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "webhook_id": {
      "type": "string",
      "minLength": 1,
      "description": "Identifier of the approved webhook subscription. After administrator approval, discover it with `webhooks.ListWebhookSubscriptions` using a credential with read access to every selected resource type. It is different from an event ID or delivery ID."
    },
    "cursor": {
      "type": "string",
      "description": "Opaque next_cursor returned by this webhook's preceding page. Keep the same webhook and credential; omit it to start a new listing."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 50,
      "description": "Maximum number of results to return in this page. Continue with next_cursor when returned."
    },
    "since": {
      "type": "integer",
      "minimum": 0,
      "description": "Earliest event creation time to return, in Unix milliseconds. Recovery is limited to the 30-day retention window."
    }
  },
  "required": [
    "webhook_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "webhook_id": "e_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "event_id": {
            "type": "string",
            "description": "Stable event identifier. Deduplicate notifications by this value, including retries and deliberate replays."
          },
          "event": {
            "type": "string",
            "enum": [
              "resource.created",
              "resource.updated",
              "resource.deleted"
            ],
            "description": "Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](/events) for payloads and delivery contracts."
          },
          "version": {
            "type": "string",
            "const": "v1",
            "description": "Payload contract version used to serialize this event."
          },
          "occurred_at": {
            "type": "string",
            "format": "date-time",
            "description": "Event creation time in Unix milliseconds."
          },
          "resource": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique identifier. Use the value returned by a create or list operation."
              },
              "type": {
                "type": "string",
                "description": "Type identifying which variant of this model applies."
              },
              "version": {
                "type": "string",
                "description": "Opaque resource revision. Events may arrive out of order."
              }
            },
            "required": [
              "id",
              "type",
              "version"
            ],
            "additionalProperties": false,
            "description": "Affected record's type and ID; the event does not include the record's complete contents."
          },
          "changed_fields": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Names of fields changed by an update, when supplied. Fetch the record to read its current values."
          },
          "test": {
            "type": "boolean",
            "const": true,
            "description": "Whether this is a synthetic test event rather than a real resource change."
          }
        },
        "required": [
          "event_id",
          "event",
          "version",
          "occurred_at",
          "resource"
        ],
        "additionalProperties": false,
        "title": "Webhook event"
      },
      "description": "Recoverable events for the selected webhook, within the 30-day retention window. Pass next_cursor as cursor to continue when a next cursor is returned."
    },
    "next_cursor": {
      "type": "string",
      "description": "Continue this webhook's listing with this value as cursor. Omitted on the final page."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "event_id": "e_example",
          "event": "resource.created",
          "version": "v1",
          "occurred_at": "2026-11-10T09:00:00.000Z",
          "resource": {
            "id": "e_example",
            "type": "core:Company",
            "version": "1"
          }
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "webhook_id": "e_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "webhook_id": "e_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "webhook_id": "e_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "webhook_id": "e_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "webhook_id": "e_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "webhook_id": "e_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/webhooks.ListWebhookEvents",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "items": [
    {
      "event_id": "e_example",
      "event": "resource.created",
      "version": "v1",
      "occurred_at": "2026-11-10T09:00:00.000Z",
      "resource": {
        "id": "e_example",
        "type": "core:Company",
        "version": "1"
      }
    }
  ]
}

Illustrative values, not a live response.