Skip to content

Document --chat-room-filter flag for integrations create/update #3474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
AndyTWF wants to merge 2 commits into
base: main
Choose a base branch
from
+27 −3
Draft

Document --chat-room-filter flag for integrations create/update #3474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be2ced0
Document --chat-room-filter flag for integrations create/update
claude Jul 17, 2026
a5d1a88
Revert meta_keywords addition on integrations create/update pages
claude Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/pages/docs/cli/integrations/create.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,19 @@ The type of integration rule to create. Valid options are `http`, `amqp`, `kines

### `--source-type` <a id="source-type"/> <RequiredBadge />

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` <a id="app"/>

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

### `--channel-filter` <a id="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 id="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` <a id="target-url"/>

Expand Down Expand Up @@ -74,6 +78,14 @@ ably integrations create --rule-type amqp --source-type channel.message --channe
```
</Code>

Create an HTTP webhook integration for a chat room with a chat room filter:

<Code>
```shell
ably integrations create --rule-type http --source-type chat.message --chat-room-filter "^support" --target-url https://example.com/webhook
```
</Code>

Create a disabled integration rule:

<Code>
Expand Down
14 changes: 13 additions & 1 deletion src/pages/docs/cli/integrations/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@ The app ID that the integration rule belongs to. If not specified, the currently

### `--channel-filter` <a id="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` <a id="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` <a id="request-mode"/>

Expand Down Expand Up @@ -80,6 +84,14 @@ ably integrations update aBcDe1 --channel-filter "^notifications"
```
</Code>

Update the chat room filter for an integration rule:

<Code>
```shell
ably integrations update aBcDe1 --chat-room-filter "^support"
```
</Code>

Update the target URL for an integration rule:

<Code>
Expand Down