AblyDocs

Integrations create

Open in

Use the ably integrations create command to create an integration rule for your Ably application.

Synopsis

ably integrations create --rule-type <type> --source-type <source> [options]

Options

--rule-type
Required

The type of integration rule to create. Valid options are http, amqp, kinesis, firehose, pulsar, kafka, azure, azure-functions, mqtt, or cloudmqtt.

--source-type
Required

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

--app

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

--channel-filter

A channel name filter to apply to the integration rule.

--target-url

The target URL for the integration rule. This option is required for http rule types.

--request-mode

The request mode for the integration rule. Valid options are single or batch. The default value is single.

--status

The initial status of the integration rule. Valid options are enabled or disabled. The default value is enabled.

--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

Create an HTTP webhook integration:

ably integrations create --rule-type http --source-type channel.message --target-url https://example.com/webhook

Create an AMQP integration with a channel filter:

ably integrations create --rule-type amqp --source-type channel.message --channel-filter "^notifications"

Create a disabled integration rule:

ably integrations create --rule-type http --source-type channel.message --target-url https://example.com/webhook --status disabled

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

ably integrations create --rule-type "http" --source-type "channel.message" --target-url "https://example.com/webhook" --json

See also