Skip to content

Brex: Webhooks schemas

15 Brex schemas with complete fields and constraints.

← Webhooks operations · All schemas

Add Webhook Group Members — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parentThe list of webhook group members to add to the group.
Minimum items: 1
members[]ModelEach itemExpand Add Webhook Group Members — request body — body members item

Referenced models: Add Webhook Group Members — request body — body members item

Add Webhook Group Members — request body — body members item

FieldTypePresenceDescription and constraints
$objectRoot
member_idstringRequired within parentThe ID of the webhook group member.
Minimum length: 1
member_typeJSONRequired within parent
member_type (allOf 1)stringAll variants applyThe type of a webhook group member.
One of: ACCOUNT
member_type (allOf 2)JSONAll variants applyThe type of webhook group member.

Create Webhook Group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name for the webhook group.

Get Webhook Group — response body

FieldTypePresenceDescription and constraints
$objectRootA 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.
idstringRequired within parentThe ID of the webhook group.
Minimum length: 1
namestringRequired within parentThe name for the webhook group.
Minimum length: 1

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

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

List Webhook Group Members — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand List Webhook Group Members — response body — items item
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: List Webhook Group Members — response body — items item

List Webhook Group Members — response body — items item

FieldTypePresenceDescription and constraints
$objectRootA member of a webhook group.
group_idstringRequired within parentThe ID of the webhook group this member belongs to.
Minimum length: 1
member_idstringRequired within parentThe ID of the webhook group member.
Minimum length: 1
member_typeJSONRequired within parent
member_type (allOf 1)stringAll variants applyThe type of a webhook group member.
Known values: ACCOUNT
member_type (allOf 2)JSONAll variants applyThe type of webhook group member.

List Webhook Groups — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get Webhook Group — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get Webhook Group — response body

List Webhook Secrets — response body — item

FieldTypePresenceDescription and constraints
$objectRootA webhook secret, which can be used to validate that incoming webhook messages were sent by Brex.
secretstringRequired within parentThe payload of the secret to be used for webhook validation.
Minimum length: 1
statusJSONRequired within parent
status (allOf 1)stringAll variants applyThe status of a webhook secret.
Known values: ACTIVE, PENDING_REVOKE, REVOKED
status (allOf 2)JSONAll variants applyThe status of this webhook secret.

List Webhooks — response body

FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand Get Webhook — response body
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: Get Webhook — response body

Register Webhook — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
event_typesarrayRequired within parentA list of the webhook event types this subscription will listen to.
Minimum items: 1
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
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

Remove Webhook Group Members — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parentThe list of webhook group members to remove from the group.
Minimum items: 1
members[]ModelEach itemExpand Add Webhook Group Members — request body — body members item

Referenced models: Add Webhook Group Members — request body — body members 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

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

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.