---
title: WebhooksPaths
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/webhooks/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L2)

## Properties

### /v1/webhooks

> **/v1/webhooks**: `object`

Defined in: [src/webhooks/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L3)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List Webhooks

##### Description

List the webhooks you have registered

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

##### get.parameters.query.limit?

> `optional` **limit?**: `number` \| `null`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Register Webhook

##### Description

Register an endpoint to start receiving selected webhook events

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header

> **header**: `object`

##### post.parameters.header.Idempotency-Key

> **Idempotency-Key**: `string`

##### post.parameters.path?

> `optional` **path?**: `undefined`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.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.

##### post.requestBody.content.application/json.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
```

##### post.requestBody.content.application/json.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
```

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Success

##### post.responses.200.content

> **content**: `object`

##### post.responses.200.content.application/json

> **application/json**: `object`

##### post.responses.200.content.application/json.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"]
```

##### post.responses.200.content.application/json.group\_id?

> `optional` **group\_id?**: `string` \| `null`

###### Description

ID of the webhook group to which this subscription applies, if any.

###### Example

```ts
wg_123
```

##### post.responses.200.content.application/json.id

> **id**: `string`

###### Description

ID of the webhook subscription.

###### Example

```ts
wsub_123
```

##### post.responses.200.content.application/json.status

> **status**: `"ACTIVE"` \| `"INACTIVE"`

##### post.responses.200.content.application/json.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
```

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.500

> **500**: `object`

###### Description

Internal server error

##### post.responses.500.content?

> `optional` **content?**: `undefined`

##### post.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/\{id\}

> **/v1/webhooks/\{id\}**: `object`

Defined in: [src/webhooks/types.gen.ts:27](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L27)

#### delete

> **delete**: `object`

Unregister Webhook

##### Description

Unregister a webhook if you want to stop receiving webhook events

##### delete.parameters

> **parameters**: `object`

##### delete.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### delete.parameters.header?

> `optional` **header?**: `undefined`

##### delete.parameters.path

> **path**: `object`

##### delete.parameters.path.id

> **id**: `string`

##### delete.parameters.query?

> `optional` **query?**: `undefined`

##### delete.requestBody?

> `optional` **requestBody?**: `undefined`

##### delete.responses

> **responses**: `object`

##### delete.responses.200

> **200**: `object`

###### Description

Success

##### delete.responses.200.content?

> `optional` **content?**: `undefined`

##### delete.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.400

> **400**: `object`

###### Description

Bad request

##### delete.responses.400.content?

> `optional` **content?**: `undefined`

##### delete.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.401

> **401**: `object`

###### Description

Unauthorized

##### delete.responses.401.content?

> `optional` **content?**: `undefined`

##### delete.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.403

> **403**: `object`

###### Description

Forbidden

##### delete.responses.403.content?

> `optional` **content?**: `undefined`

##### delete.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.500

> **500**: `object`

###### Description

Internal server error

##### delete.responses.500.content?

> `optional` **content?**: `undefined`

##### delete.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### get

> **get**: `object`

Get Webhook

##### Description

Get details of a webhook

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.id

> **id**: `string`

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.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"]
```

##### get.responses.200.content.application/json.group\_id?

> `optional` **group\_id?**: `string` \| `null`

###### Description

ID of the webhook group to which this subscription applies, if any.

###### Example

```ts
wg_123
```

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

ID of the webhook subscription.

###### Example

```ts
wsub_123
```

##### get.responses.200.content.application/json.status

> **status**: `"ACTIVE"` \| `"INACTIVE"`

##### get.responses.200.content.application/json.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
```

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put

> **put**: `object`

Update Webhook

##### Description

Update a webhook.
    You can update the endpoint url, event types that the endpoint receives, or temporarily deactivate the webhook.

##### put.parameters

> **parameters**: `object`

##### put.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### put.parameters.header?

> `optional` **header?**: `undefined`

##### put.parameters.path

> **path**: `object`

##### put.parameters.path.id

> **id**: `string`

##### put.parameters.query?

> `optional` **query?**: `undefined`

##### put.requestBody

> **requestBody**: `object`

##### put.requestBody.content

> **content**: `object`

##### put.requestBody.content.application/json

> **application/json**: `object`

##### put.requestBody.content.application/json.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.

##### put.requestBody.content.application/json.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
```

##### put.requestBody.content.application/json.status

> **status**: `"ACTIVE"` \| `"INACTIVE"`

##### put.requestBody.content.application/json.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
```

##### put.responses

> **responses**: `object`

##### put.responses.200

> **200**: `object`

###### Description

Success

##### put.responses.200.content

> **content**: `object`

##### put.responses.200.content.application/json

> **application/json**: `object`

##### put.responses.200.content.application/json.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"]
```

##### put.responses.200.content.application/json.group\_id?

> `optional` **group\_id?**: `string` \| `null`

###### Description

ID of the webhook group to which this subscription applies, if any.

###### Example

```ts
wg_123
```

##### put.responses.200.content.application/json.id

> **id**: `string`

###### Description

ID of the webhook subscription.

###### Example

```ts
wsub_123
```

##### put.responses.200.content.application/json.status

> **status**: `"ACTIVE"` \| `"INACTIVE"`

##### put.responses.200.content.application/json.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
```

##### put.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.400

> **400**: `object`

###### Description

Bad request

##### put.responses.400.content?

> `optional` **content?**: `undefined`

##### put.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.401

> **401**: `object`

###### Description

Unauthorized

##### put.responses.401.content?

> `optional` **content?**: `undefined`

##### put.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.403

> **403**: `object`

###### Description

Forbidden

##### put.responses.403.content?

> `optional` **content?**: `undefined`

##### put.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### put.responses.500

> **500**: `object`

###### Description

Internal server error

##### put.responses.500.content?

> `optional` **content?**: `undefined`

##### put.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/groups

> **/v1/webhooks/groups**: `object`

Defined in: [src/webhooks/types.gen.ts:56](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L56)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List Webhook Groups

##### Description

Lists webhook groups.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

###### Description

Cursor for pagination.

##### get.parameters.query.limit?

> `optional` **limit?**: `number`

###### Description

Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Create Webhook Group

##### Description

Creates a webhook group.

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header

> **header**: `object`

##### post.parameters.header.Idempotency-Key

> **Idempotency-Key**: `string`

##### post.parameters.path?

> `optional` **path?**: `undefined`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.name

> **name**: `string`

###### Description

The name for the webhook group.

###### Example

```ts
Some Webhook Group
```

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Success

##### post.responses.200.content

> **content**: `object`

##### post.responses.200.content.application/json

> **application/json**: `object`

##### post.responses.200.content.application/json.id

> **id**: `string`

###### Description

The ID of the webhook group.

###### Example

```ts
wg_123
```

##### post.responses.200.content.application/json.name

> **name**: `string`

###### Description

The name for the webhook group.

###### Example

```ts
Some Webhook Group
```

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.500

> **500**: `object`

###### Description

Internal server error

##### post.responses.500.content?

> `optional` **content?**: `undefined`

##### post.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/groups/\{id\}

> **/v1/webhooks/groups/\{id\}**: `object`

Defined in: [src/webhooks/types.gen.ts:80](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L80)

#### delete

> **delete**: `object`

Delete Webhook Group

##### Description

Deletes a webhook group and all its members.

##### delete.parameters

> **parameters**: `object`

##### delete.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### delete.parameters.header?

> `optional` **header?**: `undefined`

##### delete.parameters.path

> **path**: `object`

##### delete.parameters.path.id

> **id**: `string`

###### Description

The ID of the webhook group to delete.

##### delete.parameters.query?

> `optional` **query?**: `undefined`

##### delete.requestBody?

> `optional` **requestBody?**: `undefined`

##### delete.responses

> **responses**: `object`

##### delete.responses.200

> **200**: `object`

###### Description

Success

##### delete.responses.200.content?

> `optional` **content?**: `undefined`

##### delete.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.400

> **400**: `object`

###### Description

Bad request

##### delete.responses.400.content?

> `optional` **content?**: `undefined`

##### delete.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.401

> **401**: `object`

###### Description

Unauthorized

##### delete.responses.401.content?

> `optional` **content?**: `undefined`

##### delete.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.403

> **403**: `object`

###### Description

Forbidden

##### delete.responses.403.content?

> `optional` **content?**: `undefined`

##### delete.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### delete.responses.500

> **500**: `object`

###### Description

Internal server error

##### delete.responses.500.content?

> `optional` **content?**: `undefined`

##### delete.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### get

> **get**: `object`

Get Webhook Group

##### Description

Gets a webhook group.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.id

> **id**: `string`

###### Description

The ID of the webhook group to retrieve.

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

The ID of the webhook group.

###### Example

```ts
wg_123
```

##### get.responses.200.content.application/json.name

> **name**: `string`

###### Description

The name for the webhook group.

###### Example

```ts
Some Webhook Group
```

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/groups/\{id\}/add\_members

> **/v1/webhooks/groups/\{id\}/add\_members**: `object`

Defined in: [src/webhooks/types.gen.ts:104](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L104)

#### delete?

> `optional` **delete?**: `undefined`

#### get?

> `optional` **get?**: `undefined`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Add Webhook Group Members

##### Description

Adds members to webhook groups.

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path

> **path**: `object`

##### post.parameters.path.id

> **id**: `string`

###### Description

The ID of the webhook group to add members to.

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.members

> **members**: `object`[]

###### Description

The list of webhook group members to add to the group.

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Success

##### post.responses.200.content?

> `optional` **content?**: `undefined`

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.500

> **500**: `object`

###### Description

Internal server error

##### post.responses.500.content?

> `optional` **content?**: `undefined`

##### post.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/groups/\{id\}/members

> **/v1/webhooks/groups/\{id\}/members**: `object`

Defined in: [src/webhooks/types.gen.ts:124](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L124)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List Webhook Group Members

##### Description

Lists the members currently in the specified webhook group.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.id

> **id**: `string`

###### Description

The ID of the webhook group to retrieve members for.

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

###### Description

Cursor for pagination.

##### get.parameters.query.limit?

> `optional` **limit?**: `number`

###### Description

Limit for pagination. If not provided, defaults to 100. Cannot be greater than 1000.

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/groups/\{id\}/remove\_members

> **/v1/webhooks/groups/\{id\}/remove\_members**: `object`

Defined in: [src/webhooks/types.gen.ts:144](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L144)

#### delete?

> `optional` **delete?**: `undefined`

#### get?

> `optional` **get?**: `undefined`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Remove Webhook Group Members

##### Description

Removes members from webhook groups.

##### post.parameters

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path

> **path**: `object`

##### post.parameters.path.id

> **id**: `string`

###### Description

The ID of the webhook group to remove members from.

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.members

> **members**: `object`[]

###### Description

The list of webhook group members to remove from the group.

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Success

##### post.responses.200.content?

> `optional` **content?**: `undefined`

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Bad request

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.403

> **403**: `object`

###### Description

Forbidden

##### post.responses.403.content?

> `optional` **content?**: `undefined`

##### post.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.500

> **500**: `object`

###### Description

Internal server error

##### post.responses.500.content?

> `optional` **content?**: `undefined`

##### post.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/webhooks/secrets

> **/v1/webhooks/secrets**: `object`

Defined in: [src/webhooks/types.gen.ts:164](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/webhooks/types.gen.ts#L164)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List Webhook Secrets

##### Description

This endpoint returns a set of webhook signing secrets used to validate the webhook.
    Usually only one key will be returned in the response. After key rotation, this endpoint will return two keys:
    the new key, and the key that will be revoked soon. There will also be two signatures in the 'Webhook-Signature' request header.
    Your application should use all keys available to validate the webhook request. If validation passes for any
    of the keys returned, the webhook payload is valid.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`[]

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Bad request

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.403

> **403**: `object`

###### Description

Forbidden

##### get.responses.403.content?

> `optional` **content?**: `undefined`

##### get.responses.403.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.500

> **500**: `object`

###### Description

Internal server error

##### get.responses.500.content?

> `optional` **content?**: `undefined`

##### get.responses.500.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`