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
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
Only active (
true) or paused (false) webhooks. Any other value applies no restriction. One of: true, false.webhooks create
Create a webhook. Changes data. Adds a webhook with the givenurl 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
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.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.webhooks delete
Delete a webhook. Destructive: needs —yes. Removes the webhook. Nothing more is delivered to its URL. Not available on agency workspaces.Usage
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
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.Replaces the whole list; an empty list switches enrichment off. One of:
linkedin_profile, email, phone. Repeat the flag for several values.
