AblyDocs

Integrations update

Open in

Use the ably integrations update command to update an existing integration rule.

Synopsis

ably integrations update <integration-id> [options]

Arguments

integration-id
Required

The ID of the integration rule to update.

Options

--app

The app ID that the integration rule belongs to. If not specified, the currently selected app is used.

--channel-filter

Update the channel name filter for the integration rule.

--request-mode

Update the request mode for the integration rule. Valid options are single or batch.

--source

Update the source type for the integration rule. Valid options are channel.message, channel.presence, channel.lifecycle, or presence.message.

--status

Update the status of the integration rule. Valid options are enabled or disabled.

--target

Update the target configuration for the integration rule.

--target-url

Update the target URL for the integration rule.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Disable an integration rule:

ably integrations update aBcDe1 --status disabled

Update the channel filter for an integration rule:

ably integrations update aBcDe1 --channel-filter "^notifications"

Update the target URL for an integration rule:

ably integrations update aBcDe1 --target-url https://example.com/new-webhook

Update an integration rule and output the result in JSON format:

ably integrations update rule123 --status disabled --json

See also