Reference
apex notify
Notification routing: where a repository’s outcome changes are sent
apex notify [command]Examples
Tell a Slack channel when the default branch breaks and recovers; the URL is prompted for.
apex notify add acme/web ops --kind slack --on broke,recoveredThe last attempts to reach a repository's destinations.
apex notify log acme/webSubcommands
apex notify listThe rules for one repository, and how each one last faredapex notify addCreate or replace one ruleapex notify rmRemove one rule, and the record of its deliveriesapex notify testSend a message to one destination now, and report what it saidapex notify logThe last attempts to reach this repository’s destinations
apex notify list
The rules for one repository, and how each one last fared
apex notify list [options] <repository>With an API token, needs the permission notifications:read.
| Argument | Description |
|---|---|
<repository> | owner/repo |
| Option | Description |
|---|---|
--json | machine-readable output |
apex notify add
Create or replace one rule
apex notify add [options] <repository> <name>With an API token, needs the permission notifications:write.
| Argument | Description |
|---|---|
<repository> | owner/repo |
<name> | the rule name, e.g. ci-alerts |
| Option | Description |
|---|---|
--kind <kind> | destination type: slack, teams, webhook Default: slack. |
--to <url> | the destination URL; omit to be prompted, or to keep the one already stored |
--on <triggers> | comma-separated: broke, recovered, failed, succeeded (default: broke,recovered) |
--workflow <glob> | only these workflow paths (repeatable); omit for all |
--branch <glob> | only these branches (repeatable); omit for all |
--disable | store the rule but send nothing through it |
--json | machine-readable output |
apex notify rm
Remove one rule, and the record of its deliveries
apex notify rm <repository> <name>With an API token, needs the permission notifications:write.
| Argument | Description |
|---|---|
<repository> | owner/repo |
<name> | the rule name |
apex notify test
Send a message to one destination now, and report what it said
apex notify test [options] <repository> <name>With an API token, needs the permission notifications:write.
| Argument | Description |
|---|---|
<repository> | owner/repo |
<name> | the rule name |
| Option | Description |
|---|---|
--json | machine-readable output |
apex notify log
The last attempts to reach this repository’s destinations
apex notify log [options] <repository>With an API token, needs the permission notifications:read.
| Argument | Description |
|---|---|
<repository> | owner/repo |
| Option | Description |
|---|---|
--limit <n> | how many attempts to show (default 20) Default: 20. |
--json | machine-readable output |