Package ReferenceCLI (Python)
Inbox
View and manage webhook events from your connected integrations.
Inbox
Supyagent Cloud receives webhook events from your connected integrations (new emails, Slack messages, calendar invites, etc.). The inbox commands let you view, filter, and archive these events.
supyagent inbox
List webhook events from your inbox.
supyagent inboxOptions
| Flag | Type | Default | Description |
|---|---|---|---|
--status, -s | choice | — | Filter by status: unread, read, archived |
--provider, -p | string | — | Filter by provider (e.g., google, slack) |
--limit, -n | integer | 20 | Maximum number of events to show |
--event-id, -i | string | — | View a specific event by ID (shows full payload) |
--archive, -a | string | — | Archive a specific event by ID |
--archive-all | flag | — | Archive all events |
Examples
# List recent events
supyagent inbox
# Show only unread events
supyagent inbox --status unread
# Filter to Slack events
supyagent inbox --provider slack
# View a specific event with full payload
supyagent inbox --event-id evt_abc123
# Archive a single event
supyagent inbox --archive evt_abc123
# Archive all events
supyagent inbox --archive-allOutput
Events are displayed in a formatted table with relative timestamps:
ID Provider Status Summary Time
─────────────── ────────── ──────── ──────────────────────────────── ─────
evt_abc123 google unread New email from alice@example.com 5m
evt_def456 slack read Message in #general 2h
evt_ghi789 github unread PR #42 opened 3dsupyagent service inbox
List inbox events with machine-friendly output. Similar to supyagent inbox but designed for scripting and piping.
supyagent service inboxOptions
| Flag | Type | Default | Description |
|---|---|---|---|
--status, -s | choice | — | Filter by status: unread, read, archived |
--provider, -p | string | — | Filter by provider |
--limit, -l | integer | 20 | Maximum number of events |
--json | flag | — | Output as JSON |
Example
supyagent service inbox --status unread --jsonsupyagent service inbox:get
Get a single inbox event by ID, including the full event payload. Automatically marks the event as read.
supyagent service inbox:get <event-id>Options
| Flag | Type | Description |
|---|---|---|
--json | flag | Output as JSON |
Example
supyagent service inbox:get evt_abc123supyagent service inbox:archive
Archive inbox events to remove them from the default view.
supyagent service inbox:archive [event-id]Options
| Flag | Type | Description |
|---|---|---|
--all | flag | Archive all events |
--provider, -p | string | Filter by provider when using --all |
Examples
# Archive a single event
supyagent service inbox:archive evt_abc123
# Archive all events
supyagent service inbox:archive --all
# Archive all Slack events
supyagent service inbox:archive --all --provider slack