Prepare webhook — Brigg developers

Access & visibility

Allow webhooks.PrepareWebhook 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.

urlstringRequired

An HTTPS endpoint on a public host.

At least 1 character. At most 2048 characters.

eventstringRequired

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

At least 1 character. At most 64 characters.

resource_typesarray of stringOptional

Explicit resource type identifiers, such as core:Company or a workspace app's qualified type. Discover the exact values from resource on the record operations returned by GET /v1/operations using a key with access to those records. These are resource types, not app names or operation namespaces. Required and non-empty for resource.created, resource.updated and resource.deleted; omit for legacy meeting.completed. Only selected, published shared types are included; new types are never added automatically. See webhook resource selection.

Response

Returns 200 OK with a JSON body.

configurationobjectRequired

Proposed webhook settings for a person to approve in Brigg; this is not an active subscription.

Nested fields

urlstringRequired

Absolute URL, including its scheme.

eventstringRequired

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

resource_typesarray of stringRequired

approval_urlstringRequired

Path in the Brigg application where an administrator reviews this exact proposal. Open it on your Brigg application origin. Preparing a proposal does not create a subscription.

messagestringRequired

Instructions or outcome for the webhook action.

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": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048,
      "description": "An HTTPS endpoint on a public host."
    },
    "event": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](/events) for payloads and delivery contracts."
    },
    "resource_types": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "description": "Explicit resource type identifiers, such as `core:Company` or a workspace app's qualified type. Discover the exact values from `resource` on the record operations returned by `GET /v1/operations` using a key with access to those records. These are resource types, not app names or operation namespaces. Required and non-empty for `resource.created`, `resource.updated` and `resource.deleted`; omit for legacy `meeting.completed`. Only selected, published shared types are included; new types are never added automatically. See [webhook resource selection](/webhooks#choose-resource-types)."
    }
  },
  "required": [
    "url",
    "event"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "url": "https://example.com/webhooks/brigg",
      "event": "resource.updated",
      "resource_types": [
        "core:Company"
      ]
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "configuration": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "description": "Absolute URL, including its scheme."
        },
        "event": {
          "type": "string",
          "description": "Event name. Supported values: `meeting.completed`, `resource.created`, `resource.updated`, `resource.deleted`. See the [event reference](/events) for payloads and delivery contracts."
        },
        "resource_types": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Explicit resource type identifiers, such as `core:Company` or a workspace app's qualified type. Discover the exact values from `resource` on the record operations returned by `GET /v1/operations` using a key with access to those records. These are resource types, not app names or operation namespaces. Required and non-empty for `resource.created`, `resource.updated` and `resource.deleted`; omit for legacy `meeting.completed`. Only selected, published shared types are included; new types are never added automatically. See [webhook resource selection](/webhooks#choose-resource-types)."
        }
      },
      "required": [
        "url",
        "event",
        "resource_types"
      ],
      "additionalProperties": false,
      "description": "Proposed webhook settings for a person to approve in Brigg; this is not an active subscription."
    },
    "approval_url": {
      "type": "string",
      "description": "Path in the Brigg application where an administrator reviews this exact proposal. Open it on your Brigg application origin. Preparing a proposal does not create a subscription."
    },
    "message": {
      "type": "string",
      "description": "Instructions or outcome for the webhook action."
    }
  },
  "required": [
    "configuration",
    "approval_url",
    "message"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "configuration": {
        "url": "https://example.com/webhooks/brigg",
        "event": "resource.updated",
        "resource_types": [
          "core:Company"
        ]
      },
      "approval_url": "/settings/webhooks?webhook_proposal=%7B%22url%22%3A%22https%3A%2F%2Fexample.com%2Fwebhooks%2Fbrigg%22%2C%22event%22%3A%22resource.updated%22%2C%22resource_types%22%3A%5B%22core%3ACompany%22%5D%7D",
      "message": "Review the endpoint and resource access in Brigg Settings."
    }
  ]
}

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.PrepareWebhook' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "url": "https://example.com/webhooks/brigg",
  "event": "resource.updated",
  "resource_types": [
    "core:Company"
  ]
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/webhooks.PrepareWebhook", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/webhooks/brigg",
    "event": "resource.updated",
    "resource_types": [
      "core:Company"
    ]
  }),
});
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 = {
  "url": "https://example.com/webhooks/brigg",
  "event": "resource.updated",
  "resource_types": [
    "core:Company"
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/webhooks.PrepareWebhook",
    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.PrepareWebhook' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "url": "https://example.com/webhooks/brigg",
  "event": "resource.updated",
  "resource_types": [
    "core:Company"
  ]
}'

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.PrepareWebhook", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "url": "https://example.com/webhooks/brigg",
    "event": "resource.updated",
    "resource_types": [
      "core:Company"
    ]
  }),
});
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 = {
  "url": "https://example.com/webhooks/brigg",
  "event": "resource.updated",
  "resource_types": [
    "core:Company"
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/webhooks.PrepareWebhook",
    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

{
  "configuration": {
    "url": "https://example.com/webhooks/brigg",
    "event": "resource.updated",
    "resource_types": [
      "core:Company"
    ]
  },
  "approval_url": "/settings/webhooks?webhook_proposal=%7B%22url%22%3A%22https%3A%2F%2Fexample.com%2Fwebhooks%2Fbrigg%22%2C%22event%22%3A%22resource.updated%22%2C%22resource_types%22%3A%5B%22core%3ACompany%22%5D%7D",
  "message": "Review the endpoint and resource access in Brigg Settings."
}

Illustrative values, not a live response.