From be2ced0b07e6f448c2cf12bc1ebe349bf8ac2ba2 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 17 Jul 2026 16:28:31 +0000 Subject: [PATCH 1/2] Document --chat-room-filter flag for integrations create/update ably-cli PR #433 adds a --chat-room-filter flag (and a chat.message source type) to `ably integrations create` and `ably integrations update`, mirroring the existing --channel-filter option for chat-room-sourced rules. Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01BAApZnvNvLA89JZZzDdDb6 --- src/pages/docs/cli/integrations/create.mdx | 18 +++++++++++++++--- src/pages/docs/cli/integrations/update.mdx | 16 ++++++++++++++-- 2 files changed, 29 insertions(+), 5 deletions(-) diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index f01a3ae21d..c5628306d1 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -1,7 +1,7 @@ --- title: "Integrations create" meta_description: "Create an integration rule using the Ably CLI." -meta_keywords: "ably cli, cli, integrations, create, rule, webhook, ably integrations create" +meta_keywords: "ably cli, cli, integrations, create, rule, webhook, chat room filter, ably integrations create" --- Use the `ably integrations create` command to create an integration rule for your Ably application. @@ -22,7 +22,7 @@ The type of integration rule to create. Valid options are `http`, `amqp`, `kines ### `--source-type` -The source type for the integration rule. Valid options are `channel.message`, `channel.presence`, `channel.lifecycle`, or `presence.message`. +The source type for the integration rule. Valid options are `channel.message`, `channel.presence`, `channel.lifecycle`, `presence.message`, or `chat.message`. ### `--app` @@ -30,7 +30,11 @@ The app ID to create the integration rule for. If not specified, the currently s ### `--channel-filter` -A channel name filter to apply to the integration rule. +A channel name filter to apply to the integration rule. This is a regular expression, and only applies to rules with a `channel.message`, `channel.presence`, `channel.lifecycle`, or `presence.message` source type. + +### `--chat-room-filter` + +A chat room name filter to apply to the integration rule. This is a regular expression, and only applies to rules with a `chat.message` source type. ### `--target-url` @@ -74,6 +78,14 @@ ably integrations create --rule-type amqp --source-type channel.message --channe ``` +Create an HTTP webhook integration for a chat room with a chat room filter: + + +```shell +ably integrations create --rule-type http --source-type chat.message --chat-room-filter "^support" --target-url https://example.com/webhook +``` + + Create a disabled integration rule: diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx index 3eaf9b8509..96f32c6b5f 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -1,7 +1,7 @@ --- title: "Integrations update" meta_description: "Update an integration rule using the Ably CLI." -meta_keywords: "ably cli, cli, integrations, update, rule, ably integrations update" +meta_keywords: "ably cli, cli, integrations, update, rule, chat room filter, ably integrations update" --- Use the `ably integrations update` command to update an existing integration rule. @@ -28,7 +28,11 @@ The app ID that the integration rule belongs to. If not specified, the currently ### `--channel-filter` -Update the channel name filter for the integration rule. +Update the channel name filter for the integration rule. This is a regular expression, and only applies to rules with a `channel.message`, `channel.presence`, `channel.lifecycle`, or `presence.message` source type. + +### `--chat-room-filter` + +Update the chat room name filter for the integration rule. This is a regular expression, and only applies to rules with a `chat.message` source type. ### `--request-mode` @@ -80,6 +84,14 @@ ably integrations update aBcDe1 --channel-filter "^notifications" ``` +Update the chat room filter for an integration rule: + + +```shell +ably integrations update aBcDe1 --chat-room-filter "^support" +``` + + Update the target URL for an integration rule: From a5d1a880bcd68f7cbc8bd5aacd6bc9e95efc4513 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 17 Jul 2026 16:30:32 +0000 Subject: [PATCH 2/2] Revert meta_keywords addition on integrations create/update pages Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01BAApZnvNvLA89JZZzDdDb6 --- src/pages/docs/cli/integrations/create.mdx | 2 +- src/pages/docs/cli/integrations/update.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index c5628306d1..dc077e4efe 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -1,7 +1,7 @@ --- title: "Integrations create" meta_description: "Create an integration rule using the Ably CLI." -meta_keywords: "ably cli, cli, integrations, create, rule, webhook, chat room filter, ably integrations create" +meta_keywords: "ably cli, cli, integrations, create, rule, webhook, ably integrations create" --- Use the `ably integrations create` command to create an integration rule for your Ably application. diff --git a/src/pages/docs/cli/integrations/update.mdx b/src/pages/docs/cli/integrations/update.mdx index 96f32c6b5f..dc82b79e1f 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -1,7 +1,7 @@ --- title: "Integrations update" meta_description: "Update an integration rule using the Ably CLI." -meta_keywords: "ably cli, cli, integrations, update, rule, chat room filter, ably integrations update" +meta_keywords: "ably cli, cli, integrations, update, rule, ably integrations update" --- Use the `ably integrations update` command to update an existing integration rule.