Brex: Webhooks schemas
15 Brex schemas with complete fields and constraints.
← Webhooks operations · All schemas
Add Webhook Group Members — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
members | array | Required within parent | The list of webhook group members to add to the group. Minimum items: 1 |
members[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
member_id | string | Required within parent | The ID of the webhook group member. Minimum length: 1 |
member_type | JSON | Required within parent | |
member_type (allOf 1) | string | All variants apply | The type of a webhook group member. One of: ACCOUNT |
member_type (allOf 2) | JSON | All variants apply | The type of webhook group member. |
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. |
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 |
Get Webhook — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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_types | array | Required within parent | List of event types that this webhook subscription listens to. |
event_types[] | Model | Each item | Expand Get Webhook — response body — event types item |
group_id | JSON | Optional | |
group_id (anyOf 1) | string | Alternative | ID of the webhook group to which this subscription applies, if any. |
group_id (anyOf 2) | null | Alternative | |
id | string | Required within parent | ID of the webhook subscription. Minimum length: 1 |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The status of a webhook subscription. Known values: ACTIVE, INACTIVE |
status (allOf 2) | JSON | All variants apply | The status of this webhook subscription. |
url | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand List Webhook Group Members — response body — items item |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: List Webhook Group Members — response body — items item
List Webhook Group Members — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A member of a webhook group. |
group_id | string | Required within parent | The ID of the webhook group this member belongs to. Minimum length: 1 |
member_id | string | Required within parent | The ID of the webhook group member. Minimum length: 1 |
member_type | JSON | Required within parent | |
member_type (allOf 1) | string | All variants apply | The type of a webhook group member. Known values: ACCOUNT |
member_type (allOf 2) | JSON | All variants apply | The type of webhook group member. |
List Webhook Groups — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Webhook Group — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Webhook Group — response body
List Webhook Secrets — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A webhook secret, which can be used to validate that incoming webhook messages were sent by Brex. |
secret | string | Required within parent | The payload of the secret to be used for webhook validation. Minimum length: 1 |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The status of a webhook secret. Known values: ACTIVE, PENDING_REVOKE, REVOKED |
status (allOf 2) | JSON | All variants apply | The status of this webhook secret. |
List Webhooks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items | array | Required within parent | |
items[] | Model | Each item | Expand Get Webhook — response body |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative |
Referenced models: Get Webhook — response body
Register Webhook — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
event_types | array | Required within parent | A list of the webhook event types this subscription will listen to. Minimum items: 1 |
event_types[] | Model | Each item | Expand Update Webhook — request body — body event types item |
group_id | JSON | Optional | |
group_id (anyOf 1) | string | Alternative | ID of the webhook group to which this subscription applies, if any. This is only available for partners. |
group_id (anyOf 2) | null | Alternative | |
url | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
members | array | Required within parent | The list of webhook group members to remove from the group. Minimum items: 1 |
members[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
event_types | array | Required within parent | A list of the webhook event types this subscription will listen to. |
event_types[] | Model | Each item | Expand Update Webhook — request body — body event types item |
group_id | JSON | Optional | |
group_id (anyOf 1) | string | Alternative | ID of the webhook group to which this subscription applies, if any. This is only available for partners. |
group_id (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The status of a webhook subscription. One of: ACTIVE, INACTIVE |
status (allOf 2) | JSON | All variants apply | The status to set for this webhook subscription. |
url | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One 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 |