Skip to content

Brex: Update Webhook

Brex webhooks.webhooksUpdateWebhookSubscription: arguments, response, policy and SDK examples.

← Webhooks operations · Get started

Operation brex.webhooks_updatewebhooksubscription

Provider route: PUT /v1/webhooks/{id}. Alter supplies the connection’s credentials and routing.

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"]["webhooksUpdateWebhookSubscription"]>[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.webhooksUpdateWebhookSubscription(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_update_webhook_subscription(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent
bodyModelRequired within parentExpand Update Webhook — request body — body

Referenced models: Update Webhook — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Webhook — response body

Referenced models: Get Webhook — response body

Get Webhook — response body
FieldTypePresenceDescription and constraints
$objectRootA webhook subscription. When events of the specified event types occur, they will be sent to the given URL. If the subscription applies to a webhook group, then only events that apply to the members of that group will be sent. If it does not apply to any group, then only events that don't apply to any specific group will be sent. Webhook groups are only available for partners.
event_typesarrayRequired within parentList of event types that this webhook subscription listens to.
event_types[]ModelEach itemExpand Get Webhook — response body — event types item
group_idJSONOptional
group_id (anyOf 1)stringAlternativeID of the webhook group to which this subscription applies, if any.
group_id (anyOf 2)nullAlternative
idstringRequired within parentID of the webhook subscription.
Minimum length: 1
statusJSONRequired within parent
status (allOf 1)stringAll variants applyThe status of a webhook subscription.
Known values: ACTIVE, INACTIVE
status (allOf 2)JSONAll variants applyThe status of this webhook subscription.
urlstringRequired within parentThe URL to which webhook events will be sent. Must be a valid HTTPS URL.

Referenced models: Get Webhook — response body — event types item

Update Webhook — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
event_typesarrayRequired within parentA list of the webhook event types this subscription will listen to.
event_types[]ModelEach itemExpand Update Webhook — request body — body event types item
group_idJSONOptional
group_id (anyOf 1)stringAlternativeID of the webhook group to which this subscription applies, if any. This is only available for partners.
group_id (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyThe status of a webhook subscription.
One of: ACTIVE, INACTIVE
status (allOf 2)JSONAll variants applyThe status to set for this webhook subscription.
urlstringRequired within parentThe URL to which webhook events will be sent. Must be a valid HTTPS URL.

Referenced models: Update Webhook — request body — body event types item

Get Webhook — response body — event types item
FieldTypePresenceDescription and constraints
$stringRootKnown values: REFERRAL_CREATED, REFERRAL_ACTIVATED, REFERRAL_APPLICATION_STATUS_CHANGED, TRANSFER_PROCESSED, TRANSFER_FAILED, EXPENSE_PAYMENT_UPDATED, USER_UPDATED, EMBEDDED_CARD_TRANSACTION_UPDATED, EMBEDDED_CARD_UPDATED, EMBEDDED_ACCOUNT_UPDATED, EMBEDDED_CARD_SHIPPING_UPDATED, EMBEDDED_DISPUTE_UPDATED, PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED, EMBEDDED_CARD_AUTHORIZATION, EMBEDDED_FRAUD_ALERT, EMBEDDED_BILLING_GROUP_UPDATED, EMBEDDED_LEGAL_ENTITY_UPDATED, EMBEDDED_BILLING_STATEMENT_UPDATED, EMBEDDED_USER_STATUS_UPDATED, ACCOUNTING_RECORD_READY_FOR_EXPORT
Update Webhook — request body — body event types item
FieldTypePresenceDescription and constraints
$stringRootOne of: REFERRAL_CREATED, REFERRAL_ACTIVATED, REFERRAL_APPLICATION_STATUS_CHANGED, TRANSFER_PROCESSED, TRANSFER_FAILED, EXPENSE_PAYMENT_UPDATED, USER_UPDATED, EMBEDDED_CARD_TRANSACTION_UPDATED, EMBEDDED_CARD_UPDATED, EMBEDDED_ACCOUNT_UPDATED, EMBEDDED_CARD_SHIPPING_UPDATED, EMBEDDED_DISPUTE_UPDATED, PARTNERSHIP_INTEGRATION_CONNECTION_UPDATED, EMBEDDED_CARD_AUTHORIZATION, EMBEDDED_FRAUD_ALERT, EMBEDDED_BILLING_GROUP_UPDATED, EMBEDDED_LEGAL_ENTITY_UPDATED, EMBEDDED_BILLING_STATEMENT_UPDATED, EMBEDDED_USER_STATUS_UPDATED, ACCOUNTING_RECORD_READY_FOR_EXPORT

SDK function policy ID: brex.webhooks_updatewebhooksubscription. Catalog operation: webhooks:updateWebhookSubscription. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.