Skip to content

[ONB-1975] Docs: add webhooks listen command #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daleal merged 1 commit into from
May 11, 2026
Merged

[ONB-1975] Docs: add webhooks listen command #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 34 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,37 +67,38 @@ fintoc logout # Remove stored credentials

### Auth

| Command | Description |
|---|---|
| `fintoc login` | Authenticate with your API key |
| `fintoc logout` | Remove stored credentials |
| `fintoc config show` | Show active configuration |
| Command | Description |
| -------------------- | ------------------------------ |
| `fintoc login` | Authenticate with your API key |
| `fintoc logout` | Remove stored credentials |
| `fintoc config show` | Show active configuration |

### Resources

Resources follow the pattern `fintoc <resource> <action> [flags]`.

| Resource | Actions |
|---|---|
| `payment_intents` | get, list |
| `charges` | create, get, list |
| `webhook_endpoints` | create, get, list, delete |
| `checkout_sessions` | create, get, expire |
| `subscriptions` | get, list |
| `links` | get, list, delete |
| `api_keys` | list |
| `v2 transfers` | create, get, list |
| `v2 accounts` | get, list |
| `v2 account_verifications` | create, get, list |
| `v2 account_numbers` | create, get, list, delete |
| `v2 movements` | get, list |
| Resource | Actions |
| -------------------------- | ------------------------- |
| `payment_intents` | get, list |
| `charges` | create, get, list |
| `webhook_endpoints` | create, get, list, delete |
| `checkout_sessions` | create, get, expire |
| `subscriptions` | get, list |
| `links` | get, list, delete |
| `api_keys` | list |
| `v2 transfers` | create, get, list |
| `v2 accounts` | get, list |
| `v2 account_verifications` | create, get, list |
| `v2 account_numbers` | create, get, list, delete |
| `v2 movements` | get, list |

### Utilities

| Command | Description |
|---|---|
| `fintoc doctor` | Check CLI setup and connectivity |
| `fintoc open dashboard` | Open the Fintoc dashboard in your browser |
| Command | Description |
| ------------------------ | ----------------------------------------- |
| `fintoc doctor` | Check CLI setup and connectivity |
| `fintoc open dashboard` | Open the Fintoc dashboard in your browser |
| `fintoc webhooks listen` | Listen for webhook events in real time |

## Usage examples

Expand Down Expand Up @@ -135,6 +136,16 @@ fintoc webhook_endpoints delete we_test_abc123
fintoc webhook_endpoints delete we_test_abc123 --yes # Skip confirmation (CI-friendly)
```

### Listen for webhooks

You can listen for webhook events locally in real time without the need to set up any additional services. By default, all events are listened to, but you can filter by specific event types or forward them to a local endpoint for testing.

```bash
fintoc webhooks listen
fintoc webhooks listen --events payment.succeeded,payment.failed
fintoc webhooks listen --forward-to http://localhost:3000/webhooks
```

### V2 transfers (JWS required)

Transfers require a JWS private key for `create`:
Expand Down
Loading