Brex: Create Webhook Group
Brex webhooks.webhooksCreateWebhookGroup: arguments, response, policy and SDK examples.
← Webhooks operations · Get started
Operation brex.webhooks_createwebhookgroup
Provider route: POST /v1/webhooks/groups. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["webhooks"]["webhooksCreateWebhookGroup"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.webhooks.webhooksCreateWebhookGroup(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_brex import BrexIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.webhooks.webhooks_create_webhook_group(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
headers | object | Required within parent | Additional keys: not allowed |
headers.Idempotency-Key | string | Required within parent | |
body | Model | Required within parent | Expand Create Webhook Group — request body — body |
Referenced models: Create Webhook Group — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Webhook Group — response body |
Referenced models: Get Webhook Group — response body
Schemas
Section titled “Schemas”Get Webhook Group — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A webhook group, which can be used by webhook subscriptions to target only the webhook group members. When an event occurs and it belongs to a member of the group, the webhooks will be sent only to the subscriptions that are associated with the group. If there is no group associated with the event, then the webhook will be sent to all subscriptions that are not associated with any group. Webhook groups are only available for partners. |
id | string | Required within parent | The ID of the webhook group. Minimum length: 1 |
name | string | Required within parent | The name for the webhook group. Minimum length: 1 |
Create Webhook Group — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name for the webhook group. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.webhooks_createwebhookgroup. Catalog operation: webhooks:createWebhookGroup. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.