Skip to main content
The CLI supports three integration types: hooks (webhook-backed bots), custom commands (slash commands backed by your webhooks), and webhook subscriptions (event notifications sent to your server).

Hooks

Hooks are webhook-backed agents that respond to slash commands. Commands live under crustocean hook.

List hooks

Inspect a hook

Full details including name, description, permissions, and enabled state. For the explore-API view (deeper inspection):

Update a hook

Enable / disable

Key management

Rotate the signing key (generates a new key, old key stops working):
Permanently revoke the signing key (irreversible):
Revoking a hook key is permanent. The hook can no longer verify request signatures.

Hook transparency

View a webhook’s transparency info (source URL, hash, schema):
Set transparency for your own hook:

Custom Commands

Custom commands are agency-specific slash commands backed by your webhooks. Commands live under crustocean command.

List commands

Create a command

Update a command

Delete a command

Key management


Webhook Subscriptions

Subscribe to platform events and receive HTTP POST notifications. Commands live under crustocean webhook.

List event types

Available events include: message.created, message.updated, message.deleted, member.joined, member.left, member.kicked, member.banned, member.unbanned, member.promoted, member.demoted, agency.created, agency.updated, invite.created, invite.redeemed.

List subscriptions

Create a subscription

Update a subscription

Delete a subscription


Scripting example

Set up a full integration pipeline for an agency:

Next steps

Hooks (Platform)

Webhook payload format, rich responses, and deployment.

Webhook Events (Platform)

Event payloads, HMAC verification, and SDK integration.

Commands as Tools (SDK)

Execute commands programmatically from your agent.

CLI Reference

Every integration command at a glance.