> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reachboost.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Where ReachBoost posts events such as an accepted connection or a reply: list, create, change and remove a workspace's webhooks.

`reachboost webhooks` has 5 commands. Each one lists its arguments, its flags and what it is allowed to change.

Read-only

Changes data

Needs --yes

Every command also accepts the [global flags](https://docs.reachboost.io/cli/commands.md#global-flags).

## webhooks get

Read-only

Get a webhook. Read-only.

```bash Usage theme={null}
reachboost webhooks get "<webhook-uuid>"
```

**Arguments**

**\<webhook-uuid>** `uuid` *required*

The unique identifier for the webhook.

## webhooks list

Read-only

List webhooks. Read-only. The workspace's webhooks, newest first. `name` and `url` match partial, case-insensitive text; `is_active` matches exactly (`true` or `false`). Filters combine with AND. Not available on agency workspaces.

```bash Usage theme={null}
reachboost webhooks list
```

**Flags**

**--page \<n>** `number`

The page number.

**--per-page \<n>** `number`

The number of results per page.

**--name \<text>** `string`

Partial match filter on the webhook name (case-insensitive).

**--url \<text>** `string`

Partial match filter on the webhook URL (case-insensitive).

**--is-active \<value>** `enum`

Only active (`true`) or paused (`false`) webhooks. Any other value applies no restriction. One of: `true`, `false`.

**--all** `boolean`

Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with --page.

## webhooks create

Changes data

Create a webhook. Changes data. Adds a webhook with the given `url` and `events`, and an optional `name`. `enrichment` names what to enrich before each delivery (`linkedin_profile`, `email`, `phone`); omit it or send an empty list for no enrichment. Enrichment spends credits at delivery time, so a non-empty `enrichment` first runs the same credit check as enriching a lead: when the workspace cannot pay for one enrichment with these options the request is refused with `422` and nothing is saved. Not available on agency workspaces.

```bash Usage theme={null}
reachboost webhooks create
```

**Flags**

**--name \<text>** `string`

Optional, like on the integrations page; a blank name is stored as none.

**--url \<uri>** `URL`

An http or https URL.

**--events \<value>** `enum[]`

The events to deliver. A value outside the list is refused with 422. One of: `connection_request_sent`, `connection_request_accepted`, `connection_request_withdrawn`, `follow_up_message_sent`, `message_replied`, `message_success`, `lead_finished`, `lead_failed`, `lead_status_not_interested`, `lead_status_engaged`, `lead_status_interested`, `lead_status_hot_lead`, `lead_status_meeting_booked`, `lead_status_won`, `lead_status_lost`. Repeat the flag for several values.

**--is-active \<true|false>** `boolean` (default: true)

Defaults to true.

**--enrichment \<value>** `enum[]`

What to enrich before each delivery. Omit or give an empty list for no enrichment. A value outside the list is refused with 422. One of: `linkedin_profile`, `email`, `phone`. Repeat the flag for several values.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

## webhooks delete

Needs --yes

Delete a webhook. Destructive: needs --yes. Removes the webhook. Nothing more is delivered to its URL. Not available on agency workspaces.

> [!WARNING]
>
> Needs `--yes`. Without it the command shows what it would do and stops. Try it with `--dry-run` first. See [Safety](https://docs.reachboost.io/cli/safety.md#--yes).

```bash Usage theme={null}
reachboost webhooks delete "<webhook-uuid>"
```

**Arguments**

**\<webhook-uuid>** `uuid` *required*

The unique identifier for the webhook.

**Flags**

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.

**--yes** `boolean`

Confirm. Without it the command shows what it would do and stops.

## webhooks update

Changes data

Update a webhook. Changes data. A partial update: only the fields in the body change, anything omitted stays as it is. `events`, when given, replaces the whole list and must not be empty. `enrichment`, when given, replaces the whole list; an empty list switches enrichment off, a non-empty one runs the credit check described under create before anything is saved.

```bash Usage theme={null}
reachboost webhooks update "<webhook-uuid>"
```

**Arguments**

**\<webhook-uuid>** `uuid` *required*

The unique identifier for the webhook.

**Flags**

**--name \<text>** `string`

A blank name clears it.

**--url \<uri>** `URL`

**--events \<value>** `enum[]`

Replaces the whole list. One of: `connection_request_sent`, `connection_request_accepted`, `connection_request_withdrawn`, `follow_up_message_sent`, `message_replied`, `message_success`, `lead_finished`, `lead_failed`, `lead_status_not_interested`, `lead_status_engaged`, `lead_status_interested`, `lead_status_hot_lead`, `lead_status_meeting_booked`, `lead_status_won`, `lead_status_lost`. Repeat the flag for several values.

**--is-active \<true|false>** `boolean`

**--enrichment \<value>** `enum[]`

Replaces the whole list; an empty list switches enrichment off. One of: `linkedin_profile`, `email`, `phone`. Repeat the flag for several values.

**--body \<json>** `JSON`

The whole request body as JSON, instead of individual flags.

**--body-file \<path>** `path`

Read the whole request body as JSON from a file, or from stdin with -.

**--dry-run** `boolean`

Show exactly what would be sent, and send nothing.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.