Skip to content

Outbound Commands

Commands for managing outbound webhooks — sending webhooks from your application to external endpoints.

INFO

Outbound commands are part of the Send Webhooks feature. They're available in the same CLI for convenience.

Applications

Manage outbound webhook applications.

outbound applications list

List all outbound applications.

bash
hookbase outbound applications list
hookbase outbound apps ls --json

Aliases: outbound apps list, outbound apps ls

outbound applications create

Create a new outbound application.

bash
# Interactive
hookbase outbound applications create

# With options
hookbase outbound applications create \
  --name "My SaaS App" \
  --uid "my-saas-app"

Options:

OptionDescription
-n, --name <name>Application name
-u, --uid <uid>Unique identifier
-y, --yesSkip confirmation

outbound applications get

Show application details.

bash
hookbase outbound applications get app_abc123
hookbase outbound apps show app_abc123 --json

Aliases: outbound apps get, outbound apps show

outbound applications update

Update an application.

bash
hookbase outbound applications update app_abc123 --name "Updated Name"

Options:

OptionDescription
-n, --name <name>New name
-r, --rate-limit <number>Rate limit per second

outbound applications delete

Delete an application.

bash
hookbase outbound applications delete app_abc123
hookbase outbound apps rm app_abc123 --yes

Aliases: outbound apps delete, outbound apps rm

Endpoints

Manage webhook endpoints within an application.

outbound endpoints list

List endpoints for an application.

bash
hookbase outbound endpoints list --app app_abc123
hookbase outbound endpoints ls --app app_abc123 --json

Options:

OptionDescription
--app <appId>Application ID (required)

outbound endpoints create

Create a new endpoint.

bash
hookbase outbound endpoints create \
  --app app_abc123 \
  --url "https://customer.example.com/webhooks" \
  --events "order.created,order.updated"

Options:

OptionDescription
--app <appId>Application ID (required)
-u, --url <url>Endpoint URL (required)
-e, --events <events>Comma-separated event types to subscribe to
-n, --name <name>Endpoint name
-y, --yesSkip confirmation

outbound endpoints get

Show endpoint details.

bash
hookbase outbound endpoints get ep_abc123 --app app_abc123

outbound endpoints update

Update an endpoint.

bash
hookbase outbound endpoints update ep_abc123 \
  --app app_abc123 \
  --url "https://new-url.example.com/webhooks"

outbound endpoints delete

Delete an endpoint.

bash
hookbase outbound endpoints delete ep_abc123 --app app_abc123 --yes

outbound endpoints test

Send a test event to an endpoint.

bash
hookbase outbound endpoints test ep_abc123 --app app_abc123
hookbase outbound endpoints test ep_abc123 --app app_abc123 --event "order.created"

Options:

OptionDescription
--app <appId>Application ID (required)
--event <type>Event type for test (default: test.event)

outbound endpoints rotate-secret

Rotate the signing secret for an endpoint.

bash
hookbase outbound endpoints rotate-secret ep_abc123 --app app_abc123

Messages

View and manage outbound webhook messages (delivery attempts).

outbound messages list

List recent messages for an application.

bash
hookbase outbound messages list --app app_abc123
hookbase outbound messages ls --app app_abc123 --status failed

Options:

OptionDescription
--app <appId>Application ID (required)
--status <status>Filter: sent, failed, pending
--endpoint <epId>Filter by endpoint
-l, --limit <number>Number of messages (default: 50)

outbound messages get

Show message details including delivery attempts.

bash
hookbase outbound messages get msg_abc123 --app app_abc123

outbound messages retry

Retry a failed message.

bash
hookbase outbound messages retry msg_abc123 --app app_abc123

Dead Letter Queue

Manage failed outbound messages.

outbound dlq list

List dead letter queue items.

bash
hookbase outbound dlq list --app app_abc123
hookbase outbound dlq ls --app app_abc123 --json

Options:

OptionDescription
--app <appId>Application ID (required)
-l, --limit <number>Number of items (default: 50)

outbound dlq get

Show DLQ item details.

bash
hookbase outbound dlq get dlq_abc123 --app app_abc123

outbound dlq retry

Retry a single DLQ item.

bash
hookbase outbound dlq retry dlq_abc123 --app app_abc123

outbound dlq bulk-retry

Retry multiple DLQ items.

bash
hookbase outbound dlq bulk-retry --app app_abc123
hookbase outbound dlq bulk-retry --app app_abc123 --limit 100 --yes

Options:

OptionDescription
--app <appId>Application ID (required)
-l, --limit <number>Max items to retry (default: 50)
-y, --yesSkip confirmation

outbound dlq delete

Delete a DLQ item (permanently discard).

bash
hookbase outbound dlq delete dlq_abc123 --app app_abc123 --yes

Send

Send a webhook message directly from the CLI.

bash
hookbase outbound send \
  --app app_abc123 \
  --event "order.created" \
  --payload '{"order_id": "123", "amount": 4999}'

Options:

OptionDescription
--app <appId>Application ID (required)
--event <type>Event type (required)
--payload <json>JSON payload
--payload-file <path>Path to JSON payload file
--endpoint <epId>Send to specific endpoint only

Examples

bash
# Send from a file
hookbase outbound send \
  --app app_abc123 \
  --event "invoice.paid" \
  --payload-file ./invoice-event.json

# Send to a specific endpoint
hookbase outbound send \
  --app app_abc123 \
  --event "user.created" \
  --payload '{"user_id": "usr_123"}' \
  --endpoint ep_xyz789

Released under the MIT License.