Brex uses webhooks to send real-time notifications when events happen in the accounts that you manage. Use webhook subscriptions to subscribe to different webhook events.
Webhooks API (0.1)
Download OpenAPI description
Overview
Languages
Servers
Production
https://api.brex.com
Staging (Note: This is not a sandbox. It will not work with customer tokens.)
https://api-staging.brex.com
Security
OAuth2(Required scopes:
accounting.record.read
accounting.record.write
) Enum"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"
Example: "ACCOUNTING_RECORD_READY_FOR_EXPORT"
This is the id returned in the Get Company endpoint. You can use the company_id to determine which access token to use when you get the details from our API endpoints.
- Productionhttps://api.brex.com/x-webhooks/accountingRecordReadyForExport
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/accountingRecordReadyForExport
Security
OAuth2(Required scopes:
expenses.card.readonly
expenses.card
) Enum"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"
PENDING:The transaction is yet to be captured. It may be approved, yet to be approved, or yet to be declined.
DECLINED: The transaction was declined.
Enum"PENDING""DECLINED"
PURCHASE: A pending transaction for making a purchase.
REFUND: A pending transaction for a refund.
WITHDRAWAL: A pending transaction for a withdrawal.
DECLINED: A pending transaction that was declined and will not be completed.
Enum"PURCHASE""REFUND""WITHDRAWAL""DECLINED"
This is the id returned in the Get Company endpoint. You can use the company_id to determine which access token to use when you get the details from our API endpoints.
Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
The merchant associated with the expense.
A four-digit number listed in ISO 18245 for retail financial services, e.g. 4121 for Taxicabs and Rideshares. Please refer to https://en.wikipedia.org/wiki/Merchant_category_code for more details.
The reason for the payment's status.
Enum"OTHER""APPROVED""EXCEEDED_BUDGET_LIMIT""BUDGET_EXPIRED""NO_BUDGET""BUDGET_NOT_YET_STARTED""BUDGET_CATEGORY_RESTRICTION""BUDGET_MERCHANT_RESTRICTION""SUSPECTED_FRAUD""EXCEEDED_GLOBAL_LIMIT"
Version of this expense. This value starts at 1 and is incremented by 1 with every update.
Example: 1
- Productionhttps://api.brex.com/x-webhooks/expensePaymentUpdated
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/expensePaymentUpdated
Security
OAuth2(Required scopes: )
https://onboarding.brexapis.com/...
Enum"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"
- Productionhttps://api.brex.com/x-webhooks/referralActivated
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/referralActivated
Security
OAuth2(Required scopes: )
https://onboarding.brexapis.com/...
Enum"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"
The product application details for the referral.
Application status of a product.
NO_ACCOUNT - There is no active application, and the product account is not provisioned.
ACTIVE - The application is approved, and the product account is provisioned.
NOT_SUBMITTED - The application is started but not yet submitted.
INFORMATION_PENDING - The application is submitted and additional information is requested.
MANUAL_REVIEW - The application is under manual review.
PROCESSING - The application is submitted and is under review.
REJECTED - The application is rejected.
CLOSED - The product account is closed.
Enum"NO_ACCOUNT""ACTIVE""NOT_SUBMITTED""INFORMATION_PENDING""MANUAL_REVIEW""PROCESSING""REJECTED""CLOSED"
- Productionhttps://api.brex.com/x-webhooks/referralApplicationStatusChanged
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/referralApplicationStatusChanged
Bodyapplication/jsonrequired
Enum"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"
- Productionhttps://api.brex.com/x-webhooks/referralCreated
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/referralCreated
Security
OAuth2(Required scopes:
transfers.readonly
transfers
) Enum"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"
Only ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, and STABLECOIN details can be retrieved from the Payments API.
Enum"ACH""DOMESTIC_WIRE""CHEQUE""INTERNATIONAL_WIRE""BOOK_TRANSFER""STABLECOIN""ACH_RETURN""WIRE_RETURN""CHEQUE_RETURN"
The original transaction ID that is returned when the payment type is ACH_RETURN, WIRE_RETURN and CHEQUE_RETURN.
This is the id returned in the Get Company endpoint. You can use the company_id to determine which access token to use when you get the details from our API endpoints.
- Productionhttps://api.brex.com/x-webhooks/transferFailed
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/transferFailed
Security
OAuth2(Required scopes:
transfers.readonly
transfers
) Enum"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"
Only ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, and STABLECOIN details can be retrieved from the Payments API.
Enum"ACH""DOMESTIC_WIRE""CHEQUE""INTERNATIONAL_WIRE""BOOK_TRANSFER""STABLECOIN""ACH_RETURN""WIRE_RETURN""CHEQUE_RETURN"
The original transaction ID that is returned when the payment type is ACH_RETURN, WIRE_RETURN and CHEQUE_RETURN.
This is the id returned in the Get Company endpoint. You can use the company_id to determine which access token to use when you get the details from our API endpoints.
- Productionhttps://api.brex.com/x-webhooks/transferProcessed
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/transferProcessed
Bodyapplication/jsonrequired
Enum"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"
- Productionhttps://api.brex.com/x-webhooks/userUpdated
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/x-webhooks/userUpdated