CLICommand reference
Notifications
Generated reference for nimbu notifications
Generated from the CLI command contract. Do not edit this page manually.
nimbu notifications
Manage notifications
nimbu notifications copy
Copy notifications between sites
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--only | no | * | Notification slug to copy |
--from | yes | Source site | |
--to | yes | Target site | |
--from-host | no | Source API base URL or host | |
--to-host | no | Target API base URL or host |
nimbu notifications count
Count notifications
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--locale | no | Locale filter; localized resources use it as content locale | |
--filters | no | Filter by key=value, repeatable |
nimbu notifications create
Create notification from JSON
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. slug=order_created, subject=Hello) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--locale | no | Content locale for localized notification fields | |
--file | no | Read notification JSON from file (use - for stdin) |
nimbu notifications delete
Delete notification
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--notification | yes | Notification slug or identifier |
nimbu notifications get
Get notification details
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--notification | yes | Notification slug or identifier | |
--locale | no | Content locale for localized notification fields |
nimbu notifications list
List notifications
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--fields | no | Comma-separated fields to return | |
--locale | no | Locale filter; localized resources use it as content locale | |
--include | no | Include related resources | |
--sort | no | Sort by field, e.g. field or field:desc | |
--filters | no | Filter by key=value, repeatable | |
--all | no | Fetch all pages | |
--page | no | 1 | Page number |
--per-page | no | 25 | Items per page |
nimbu notifications pull
Download notification templates
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--only | no | Only these notification slugs |
nimbu notifications push
Upload notification templates
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
-o, --only | no | Notification slugs to push |
nimbu notifications update
Update notification
Arguments
| Name | Required | Description |
|---|---|---|
assignments | no | Inline assignments (e.g. subject=Hello, html_enabled:=true) |
Flags
| Flag | Required | Default | Description |
|---|---|---|---|
--notification | yes | Notification slug or identifier | |
--locale | no | Content locale for localized notification fields | |
--file | no | Read notification JSON from file (use - for stdin) |