diff --git a/src/pages/docs/cli/integrations/create.mdx b/src/pages/docs/cli/integrations/create.mdx index f01a3ae21d..dc077e4efe 100644 --- a/src/pages/docs/cli/integrations/create.mdx +++ b/src/pages/docs/cli/integrations/create.mdx @@ -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..dc82b79e1f 100644 --- a/src/pages/docs/cli/integrations/update.mdx +++ b/src/pages/docs/cli/integrations/update.mdx @@ -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: