Skip to main content
reachboost webhooks has 5 commands. Each one lists its arguments, its flags and what it is allowed to change. Every command also accepts the global flags.

webhooks get

Get a webhook. Read-only.
Usage
Arguments
uuid
required
The unique identifier for the webhook.

webhooks list

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.
Usage
Flags
number
The page number.
number
The number of results per page.
string
Partial match filter on the webhook name (case-insensitive).
string
Partial match filter on the webhook URL (case-insensitive).
enum
Only active (true) or paused (false) webhooks. Any other value applies no restriction. One of: true, false.
boolean
Fetch every page (up to 200 pages of 100) instead of one. Cannot be combined with —page.

webhooks create

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.
Usage
Flags
string
Optional, like on the integrations page; a blank name is stored as none.
URL
An http or https URL.
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.
boolean
default:"true"
Defaults to true.
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.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.

webhooks delete

Delete a webhook. Destructive: needs —yes. Removes the webhook. Nothing more is delivered to its URL. Not available on agency workspaces.
Needs --yes. Without it the command shows what it would do and stops. Try it with --dry-run first. See Safety.
Usage
Arguments
uuid
required
The unique identifier for the webhook.
Flags
boolean
Show exactly what would be sent, and send nothing.
boolean
Confirm. Without it the command shows what it would do and stops.

webhooks update

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.
Usage
Arguments
uuid
required
The unique identifier for the webhook.
Flags
string
A blank name clears it.
URL
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.
boolean
enum[]
Replaces the whole list; an empty list switches enrichment off. One of: linkedin_profile, email, phone. Repeat the flag for several values.
JSON
The whole request body as JSON, instead of individual flags.
path
Read the whole request body as JSON from a file, or from stdin with -.
boolean
Show exactly what would be sent, and send nothing.