For the complete documentation index, see llms.txt. This page is also available as Markdown.

notifications

Manage per-user notification subscriptions — the email and webhook alerts routed on flow, connection, and integration events (errors, status changes, completions).

REST API: Notifications

celigo notifications <subcommand> [flags]

Supports all global flags.


Subcommands

Subcommand
Purpose

list

List every notification subscription in the account.

subscribe

Subscribe a user to one or more flows, connections, or integrations.

unsubscribe

Unsubscribe a user from one or more flows, connections, or integrations.


celigo notifications list

List all notification subscriptions in the account.

Signature

celigo notifications list

Arguments

None.

Flags

None beyond the global flags (--format, --jq, --profile, --verbose).

Example

Default table columns: _id, type, _integrationId, _flowId, _connectionId, subscribedByUser.email, lastModified.

Corresponds to: GET /v1/notifications?users=all


celigo notifications subscribe

Subscribe a user to notifications on one or more resources. At least one of --flow, --connection, or --integration must be provided. The CLI builds one subscribe item per ID and batches at 50 items per request.

Signature

Arguments

None. Targets are supplied via flags.

Flags

Flag
Type
Required
Description

--user <email>

string

Yes

Email of the user to subscribe.

--flow <ids...>

string[]

No

One or more flow IDs to subscribe the user to. Repeatable.

--connection <ids...>

string[]

No

One or more connection IDs. Repeatable.

--integration <ids...>

string[]

No

One or more integration IDs. Repeatable.

Examples

Corresponds to: PUT /v1/notifications (one item per ID, subscribed: true)


celigo notifications unsubscribe

Unsubscribe a user from notifications on one or more resources. At least one of --flow, --connection, or --integration must be provided. Same batching behavior as subscribe.

Signature

Arguments

None. Targets are supplied via flags.

Flags

Flag
Type
Required
Description

--user <email>

string

Yes

Email of the user to unsubscribe.

--flow <ids...>

string[]

No

One or more flow IDs to unsubscribe from. Repeatable.

--connection <ids...>

string[]

No

One or more connection IDs. Repeatable.

--integration <ids...>

string[]

No

One or more integration IDs. Repeatable.

Examples

Corresponds to: PUT /v1/notifications (one item per ID, subscribed: false)


Gotchas

  • One resource type per item. Each subscribe/unsubscribe item targets exactly one of _flowId, _connectionId, or _integrationId. Passing multiple target flags on one command is fine — the CLI expands them into separate items.

  • Account-scoped admin op. list passes users=all, so it returns subscriptions for every user in the account, not just the caller's own.

  • Per-item results, overall 200 OK. The underlying PUT /v1/notifications always returns 200 OK even when individual items fail (e.g. a referenced _flowId doesn't exist returns statusCode: 422 on that item only). Inspect the per-item statusCode in the response.

  • Batched at 50. Large subscribe/unsubscribe requests are chunked; the CLI prints the result of the last batch.

  • The response is not the subscription object. PUT returns a per-item status array — run celigo notifications list afterward to read the post-upsert state.

  • subscriptions — account-level license/plan subscriptions and usage (unrelated to notification subscriptions despite the name overlap).

  • workspace-users — manage the users whose emails appear in --user.

  • flows, connections, integrations — the resources you subscribe users to.

Last updated

Was this helpful?