--- title: WebhooksComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/webhooks/types.gen.ts:190](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L190) ## Properties ### headers > **headers**: `never` Defined in: [src/webhooks/types.gen.ts:596](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L596) *** ### parameters > **parameters**: `never` Defined in: [src/webhooks/types.gen.ts:594](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L594) *** ### pathItems > **pathItems**: `never` Defined in: [src/webhooks/types.gen.ts:597](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L597) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/webhooks/types.gen.ts:595](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L595) *** ### responses > **responses**: `never` Defined in: [src/webhooks/types.gen.ts:593](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L593) *** ### schemas > **schemas**: `object` Defined in: [src/webhooks/types.gen.ts:191](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L191) #### AccountingRecordReadyForExport > **AccountingRecordReadyForExport**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### accountingRecordIds > **accountingRecordIds**: `string`[] ###### Description List of accounting record IDs ready for export. ###### companyId > **companyId**: `string` ###### Description This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type > **event\_type**: `"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"` ##### Description A list of accounting records are ready for export. #### AddWebhookGroupMembersRequest > **AddWebhookGroupMembersRequest**: `object` ##### AddWebhookGroupMembersRequest.members > **members**: `object`[] ###### Description The list of webhook group members to add to the group. #### ApplicationStatus > **ApplicationStatus**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` ##### Description 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. #### CreateWebhookGroupRequest > **CreateWebhookGroupRequest**: `object` ##### CreateWebhookGroupRequest.name > **name**: `string` ###### Description The name for the webhook group. ###### Example ```ts Some Webhook Group ``` #### CreateWebhookSubscriptionRequest > **CreateWebhookSubscriptionRequest**: `object` ##### CreateWebhookSubscriptionRequest.event\_types > **event\_types**: (`"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"`)[] ###### Description A list of the webhook event types this subscription will listen to. ##### CreateWebhookSubscriptionRequest.group\_id? > `optional` **group\_id?**: `string` \| `null` ###### Description ID of the webhook group to which this subscription applies, if any. This is only available for partners. ###### Example ```ts wg_123 ``` ##### CreateWebhookSubscriptionRequest.url > **url**: `string` ###### Description The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example ```ts https://example.com/webhook ``` #### EventWrapper > **EventWrapper**: `Record`\<`string`, `never`\> #### ExpensePaymentStatus > **ExpensePaymentStatus**: `"DECLINED"` \| `"PENDING"` ##### Description `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. #### ExpensePaymentType > **ExpensePaymentType**: `"DECLINED"` \| `"PURCHASE"` \| `"REFUND"` \| `"WITHDRAWAL"` ##### Description `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. #### ExpensePaymentUpdated > **ExpensePaymentUpdated**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### amount? > `optional` **amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### billing\_amount? > `optional` **billing\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### card\_id > **card\_id**: `string` ###### Description The ID of the card that is associated with the expense. ###### company\_id > **company\_id**: `string` ###### Description This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type > **event\_type**: `"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"` ###### expense\_id > **expense\_id**: `string` ###### Description Unique ID associated with the expense. ###### merchant > **merchant**: `object` ###### merchant.country > **country**: `string` ###### Description Merchant's country, in ISO 3166-1 alpha-3 format. ###### merchant.mcc > **mcc**: `string` ###### Description 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. ###### merchant.raw\_descriptor > **raw\_descriptor**: `string` ###### Description Merchant descriptor, it can be the merchant name. ###### original\_amount? > `optional` **original\_amount?**: \{ `amount`: `number`; `currency`: `string` \| `null`; \} \| `null` ###### Union Members ###### Type Literal \{ `amount`: `number`; `currency`: `string` \| `null`; \} ###### amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ###### currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` *** `null` ###### payment\_authorization\_code? > `optional` **payment\_authorization\_code?**: `string` \| `null` ###### Description The authorization code of the associated card expense. ###### ~~payment\_description~~ > **payment\_description**: `string` :::caution[Deprecated] This API is no longer supported and may be removed in a future release. ::: ###### Description Succeeded by the merchant::raw_descriptor field. ###### payment\_status > **payment\_status**: `"DECLINED"` \| `"PENDING"` ###### payment\_status\_reason > **payment\_status\_reason**: `"APPROVED"` \| `"OTHER"` \| `"EXCEEDED_BUDGET_LIMIT"` \| `"BUDGET_EXPIRED"` \| `"NO_BUDGET"` \| `"BUDGET_NOT_YET_STARTED"` \| `"BUDGET_CATEGORY_RESTRICTION"` \| `"BUDGET_MERCHANT_RESTRICTION"` \| `"SUSPECTED_FRAUD"` \| `"EXCEEDED_GLOBAL_LIMIT"` \| `"EXCEEDED_USER_LIMIT"` \| `"EXCEEDED_CARD_LIMIT"` \| `"INVALID_EXPIRATION_DATE"` \| `"CARD_NOT_ACTIVE"` \| `"INVALID_CARD_CREDENTIALS"` \| `"INVALID_BILLING_ADDRESS"` \| `"CARD_SUSPENDED"` \| `"CARD_TERMINATED"` \| `"CARD_EXPIRED"` \| `"MCC_BLOCKED"` \| `"USER_SUSPENDED"` \| `"INVALID_PIN"` \| `"INVALID_CVV"` \| `"EXCEEDED_PIN_ATTEMPTS"` \| `"INSIDE_SANCTIONED_COUNTRY"` \| `"SOFT_EXPIRATION"` \| `"TRANSFERRED_CARD_NEW_MERCHANT"` \| `"EXCEEDED_ANCESTOR_BUDGET_LIMIT"` \| `"EXCEEDED_BUDGET_TRANSACTION_LIMIT"` \| `"TOS_BLOCKED"` \| `"COMPLIANCE_BLOCKED"` ###### payment\_type > **payment\_type**: `"DECLINED"` \| `"PURCHASE"` \| `"REFUND"` \| `"WITHDRAWAL"` ###### purchased\_at? > `optional` **purchased\_at?**: `string` \| `null` Format: date-time ###### Description The time the purchase was made. ###### version > **version**: `number` Format: int32 ###### Description Version of this expense. This value starts at 1 and is incremented by 1 with every update. ###### Example ```ts 1 ``` ##### Description The webhook will be sent when an expense payment changes status. Subscription must be registered with a user with the CARD_ADMIN role. #### Merchant > **Merchant**: `object` ##### Merchant.country > **country**: `string` ###### Description Merchant's country, in ISO 3166-1 alpha-3 format. ##### Merchant.mcc > **mcc**: `string` ###### Description 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. ##### Merchant.raw\_descriptor > **raw\_descriptor**: `string` ###### Description Merchant descriptor, it can be the merchant name. #### Money > **Money**: `object` ##### Description 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.amount > **amount**: `number` Format: int64 ###### Description The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents. ###### Example ```ts 700 ``` ##### Money.currency > **currency**: `string` \| `null` ###### Description The type of currency, in ISO 4217 format. ###### Default ```ts USD ``` ###### Example ```ts USD ``` #### Page\_WebhookGroup\_ > **Page\_WebhookGroup\_**: `object` ##### Page\_WebhookGroup\_.items > **items**: `object`[] ##### Page\_WebhookGroup\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_WebhookGroupMember\_ > **Page\_WebhookGroupMember\_**: `object` ##### Page\_WebhookGroupMember\_.items > **items**: `object`[] ##### Page\_WebhookGroupMember\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_WebhookSubscription\_ > **Page\_WebhookSubscription\_**: `object` ##### Page\_WebhookSubscription\_.items > **items**: `object`[] ##### Page\_WebhookSubscription\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### PaymentStatusReason > **PaymentStatusReason**: `"APPROVED"` \| `"OTHER"` \| `"EXCEEDED_BUDGET_LIMIT"` \| `"BUDGET_EXPIRED"` \| `"NO_BUDGET"` \| `"BUDGET_NOT_YET_STARTED"` \| `"BUDGET_CATEGORY_RESTRICTION"` \| `"BUDGET_MERCHANT_RESTRICTION"` \| `"SUSPECTED_FRAUD"` \| `"EXCEEDED_GLOBAL_LIMIT"` \| `"EXCEEDED_USER_LIMIT"` \| `"EXCEEDED_CARD_LIMIT"` \| `"INVALID_EXPIRATION_DATE"` \| `"CARD_NOT_ACTIVE"` \| `"INVALID_CARD_CREDENTIALS"` \| `"INVALID_BILLING_ADDRESS"` \| `"CARD_SUSPENDED"` \| `"CARD_TERMINATED"` \| `"CARD_EXPIRED"` \| `"MCC_BLOCKED"` \| `"USER_SUSPENDED"` \| `"INVALID_PIN"` \| `"INVALID_CVV"` \| `"EXCEEDED_PIN_ATTEMPTS"` \| `"INSIDE_SANCTIONED_COUNTRY"` \| `"SOFT_EXPIRATION"` \| `"TRANSFERRED_CARD_NEW_MERCHANT"` \| `"EXCEEDED_ANCESTOR_BUDGET_LIMIT"` \| `"EXCEEDED_BUDGET_TRANSACTION_LIMIT"` \| `"TOS_BLOCKED"` \| `"COMPLIANCE_BLOCKED"` ##### Description The reason for the payment's status. #### PaymentType > **PaymentType**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` \| `"ACH_RETURN"` \| `"WIRE_RETURN"` \| `"CHEQUE_RETURN"` ##### Description Only ACH, DOMESTIC_WIRE, CHEQUE, INTERNATIONAL_WIRE, BOOK_TRANSFER, and STABLECOIN details can be retrieved from the Payments API. #### ProductApplication > **ProductApplication**: `object` ##### Description The product application details for the referral. ##### ProductApplication.cash > **cash**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` #### ReferralActivated > **ReferralActivated**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### event\_type > **event\_type**: `"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"` ###### referral\_id > **referral\_id**: `string` ###### Description The referral ID ##### Description The webhook will be sent when a user signs up with the referral link. #### ReferralApplicationStatusChanged > **ReferralApplicationStatusChanged**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### application > **application**: `object` ###### application.cash > **cash**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` ###### event\_type > **event\_type**: `"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"` ###### referral\_id > **referral\_id**: `string` ###### Description The referral ID ##### Description The webhook will be sent when the application status is changed. #### ReferralCreated > **ReferralCreated**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### event\_type > **event\_type**: `"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"` ###### referral\_id > **referral\_id**: `string` ###### Description The referral ID ##### Description The webhook will be sent when a referral is created. #### RemoveWebhookGroupMembersRequest > **RemoveWebhookGroupMembersRequest**: `object` ##### RemoveWebhookGroupMembersRequest.members > **members**: `object`[] ###### Description The list of webhook group members to remove from the group. #### TransferFailed > **TransferFailed**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### company\_id > **company\_id**: `string` ###### Description This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type > **event\_type**: `"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"` ###### payment\_type > **payment\_type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` \| `"ACH_RETURN"` \| `"WIRE_RETURN"` \| `"CHEQUE_RETURN"` ###### return\_for\_id? > `optional` **return\_for\_id?**: `string` \| `null` ###### Description The original transaction ID that is returned when the payment type is ACH_RETURN, WIRE_RETURN and CHEQUE_RETURN. ###### transfer\_id > **transfer\_id**: `string` ###### Description The transfer ID ##### Description The webhook will be sent when a transfer failed. #### TransferProcessed > **TransferProcessed**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### company\_id > **company\_id**: `string` ###### Description This is the `id` returned in the [Get Company](/openapi/team_api/#operation/getCompany) endpoint. You can use the `company_id` to determine which access token to use when you get the details from our API endpoints. ###### event\_type > **event\_type**: `"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"` ###### payment\_type > **payment\_type**: `"ACH"` \| `"DOMESTIC_WIRE"` \| `"CHEQUE"` \| `"INTERNATIONAL_WIRE"` \| `"BOOK_TRANSFER"` \| `"STABLECOIN"` \| `"ACH_RETURN"` \| `"WIRE_RETURN"` \| `"CHEQUE_RETURN"` ###### return\_for\_id? > `optional` **return\_for\_id?**: `string` \| `null` ###### Description The original transaction ID that is returned when the payment type is ACH_RETURN, WIRE_RETURN and CHEQUE_RETURN. ###### transfer\_id > **transfer\_id**: `string` ###### Description The transfer ID ##### Description The webhook will be sent when a transfer is processed. #### UpdateWebhookSubscriptionRequest > **UpdateWebhookSubscriptionRequest**: `object` ##### UpdateWebhookSubscriptionRequest.event\_types > **event\_types**: (`"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"`)[] ###### Description A list of the webhook event types this subscription will listen to. ##### UpdateWebhookSubscriptionRequest.group\_id? > `optional` **group\_id?**: `string` \| `null` ###### Description ID of the webhook group to which this subscription applies, if any. This is only available for partners. ###### Example ```ts wg_123 ``` ##### UpdateWebhookSubscriptionRequest.status > **status**: `"ACTIVE"` \| `"INACTIVE"` ##### UpdateWebhookSubscriptionRequest.url > **url**: `string` ###### Description The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example ```ts https://example.com/webhook ``` #### UserAttributes > **UserAttributes**: `"STATUS"` \| `"MANAGER_ID"` \| `"DEPARTMENT_ID"` \| `"LOCATION_ID"` #### UserUpdated > **UserUpdated**: `object` & `Record`\<`string`, `never`\> ##### Type Declaration ###### company\_id > **company\_id**: `string` ###### event\_type > **event\_type**: `"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"` ###### updated\_attributes > **updated\_attributes**: (`"STATUS"` \| `"MANAGER_ID"` \| `"DEPARTMENT_ID"` \| `"LOCATION_ID"`)[] ###### user\_id > **user\_id**: `string` ##### Description The webhook will be sent when a user is updated. #### WebhookEventType > **WebhookEventType**: `"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"` #### WebhookGroup > **WebhookGroup**: `object` Webhook Group ##### Description 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. ##### WebhookGroup.id > **id**: `string` ###### Description The ID of the webhook group. ###### Example ```ts wg_123 ``` ##### WebhookGroup.name > **name**: `string` ###### Description The name for the webhook group. ###### Example ```ts Some Webhook Group ``` #### WebhookGroupMember > **WebhookGroupMember**: `object` Webhook Group Member ##### Description A member of a webhook group. ##### WebhookGroupMember.group\_id > **group\_id**: `string` ###### Description The ID of the webhook group this member belongs to. ###### Example ```ts wg_123 ``` ##### WebhookGroupMember.member\_id > **member\_id**: `string` ###### Description The ID of the webhook group member. ###### Example ```ts cuacc_123 ``` ##### WebhookGroupMember.member\_type > **member\_type**: `"ACCOUNT"` #### WebhookGroupMemberInput > **WebhookGroupMemberInput**: `object` ##### WebhookGroupMemberInput.member\_id > **member\_id**: `string` ###### Description The ID of the webhook group member. ##### WebhookGroupMemberInput.member\_type > **member\_type**: `"ACCOUNT"` #### WebhookGroupMemberType > **WebhookGroupMemberType**: `"ACCOUNT"` ##### Description The type of a webhook group member. #### WebhookSecret > **WebhookSecret**: `object` Webhook Secret ##### Description A webhook secret, which can be used to validate that incoming webhook messages were sent by Brex. ##### WebhookSecret.secret > **secret**: `string` ###### Description The payload of the secret to be used for webhook validation. ###### Example ```ts whsec_123 ``` ##### WebhookSecret.status > **status**: `"ACTIVE"` \| `"PENDING_REVOKE"` \| `"REVOKED"` #### WebhookSecretStatus > **WebhookSecretStatus**: `"ACTIVE"` \| `"PENDING_REVOKE"` \| `"REVOKED"` ##### Description The status of a webhook secret. #### WebhookSubscription > **WebhookSubscription**: `object` Webhook Subscription ##### Description 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. ##### WebhookSubscription.event\_types > **event\_types**: (`"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"`)[] ###### Description List of event types that this webhook subscription listens to. ###### Example ```ts ["EXPENSE_PAYMENT_UPDATED"] ``` ##### WebhookSubscription.group\_id? > `optional` **group\_id?**: `string` \| `null` ###### Description ID of the webhook group to which this subscription applies, if any. ###### Example ```ts wg_123 ``` ##### WebhookSubscription.id > **id**: `string` ###### Description ID of the webhook subscription. ###### Example ```ts wsub_123 ``` ##### WebhookSubscription.status > **status**: `"ACTIVE"` \| `"INACTIVE"` ##### WebhookSubscription.url > **url**: `string` ###### Description The URL to which webhook events will be sent. Must be a valid HTTPS URL. ###### Example ```ts https://example.com/webhook ``` #### WebhookSubscriptionStatus > **WebhookSubscriptionStatus**: `"ACTIVE"` \| `"INACTIVE"` ##### Description The status of a webhook subscription.