Skip to content

Docs review integrations #577

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

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Docs review integrations #577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d30453e
IntelliJ docs update
novalisdenahi Jun 26, 2025
b44fcca
Jira docs update
novalisdenahi Jun 26, 2025
bcc10be
monday fix
novalisdenahi Jun 26, 2025
cea196d
vscode update
novalisdenahi Jun 26, 2025
9f40d2c
amplitude install/uninstall update
novalisdenahi Jun 26, 2025
91fbcca
zapier text update
novalisdenahi Jun 27, 2025
cf156b6
Zoho text update
novalisdenahi Jun 27, 2025
81d25e5
datadog update
novalisdenahi Jun 28, 2025
7a44ee9
Delete not relevant zapier png
novalisdenahi Jun 30, 2025
9b68a25
Update website/docs/integrations/amplitude.mdx
novalisdenahi Jul 7, 2025
2c14355
Update website/docs/integrations/datadog.mdx
novalisdenahi Jul 7, 2025
975b58d
Update website/docs/integrations/intellij.mdx
novalisdenahi Jul 7, 2025
da680cb
Update website/docs/integrations/zapier.mdx
novalisdenahi Jul 7, 2025
878dd05
Update website/docs/integrations/zapier.mdx
novalisdenahi Jul 7, 2025
8766c97
Update website/versioned_docs/version-V1/integrations/intellij.mdx
novalisdenahi Jul 7, 2025
5b695e4
UX guidline update
novalisdenahi Jul 7, 2025
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
Binary file removed website/docs/assets/zapier_signin.png
View file
Open in desktop
Binary file not shown.
7 changes: 5 additions & 2 deletions website/docs/integrations/amplitude.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ Every feature flag change in ConfigCat is annotated on the Amplitude charts as a
2. Get an <a href="https://www.docs.developers.amplitude.com/analytics/find-api-credentials/" target="_blank">Amplitude API Key and Secret Key.</a>
<img src="/docs/assets/amplitude_apikey_secretkey.png" alt="amplitude_apikey_secretkey" decoding="async" loading="lazy"/>
3. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
4. Click on Amplitude's CONNECT button and set your Amplitude API key and Secret key.
4. Click on Amplitude's **Connect** button and set your Amplitude API key and Secret key.
5. You're all set. Go ahead and make some changes on your feature flags, then check your charts in Amplitude.

### Un-installation

1. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
2. Click on Amplitude's DISCONNECT button.
2. Click on Amplitude's **Connected** button.
2. Select the connection from the **Connected** dropdown.
3. Click the **Disconnect** button in the edit dialog.
4. Click **Yes** in the confirmation dialog.

### Chart Annotation

Expand Down
9 changes: 6 additions & 3 deletions website/docs/integrations/datadog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: ConfigCat Datadog integration. This is a step-by-step guide on how

## Overview

Ensures that every setting change in ConfigCat is sent to Datadog as an Event.
Monitor feature flag events in real-time. Feature flag changes will appear as events in Datadog, tagged with relevant product, config, and environment details.

<img src="/docs/assets/datadog-event_192dpi.png" alt="Feature flag events logged to Datadog" width="1366" height="219" decoding="async" loading="lazy" />

Expand All @@ -18,14 +18,17 @@ Ensures that every setting change in ConfigCat is sent to Datadog as an Event.
<img src="/docs/assets/datadog-apikey_192dpi.png" alt="Datadog API Key" width="1366" height="430" decoding="async" loading="lazy" />

3. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
4. Click on Datadog's CONNECT button and set your Datadog API key.
4. Click on Datadog's **Connect** button and set your Datadog API key.
5. OPTIONAL - Set the proper site of your Datadog account. [More about Datadog site](https://docs.datadoghq.com/getting_started/site/).
6. You're all set. Go ahead and make some changes on your feature flags, then check your Events in Datadog.

## Un-installation

1. Open the <a href="https://app.configcat.com/product/integrations" target="_blank">integrations tab</a> on ConfigCat Dashboard.
2. Click on Datadog's DISCONNECT button.
2. Click on Datadog's **Connected** button.
3. Select the connection from the **Connected** dropdown.
4. Click the **Disconnect** button in the edit dialog.
5. Click **Yes** in the confirmation dialog.

## Event details

Expand Down
52 changes: 26 additions & 26 deletions website/docs/integrations/intellij.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ This guide will help you install the JetBrains/IntelliJ IDE Plugin and familiari

### Install within the IDE from Marketplace

1. In your IDE, open the `File` > `Settings/Preferences` menu.
1. Go to the `Plugin` page and select the `Marketplace` tab.
1. Search for `ConfigCat Feature Flags`.
1. `Install` the plugin.
1. In your IDE, open the **File** > **Settings/Preferences** menu.
1. Go to the **Plugin** page and select the **Marketplace** tab.
1. Search for **ConfigCat Feature Flags**.
1. **Install** the plugin.
1. Configure the plugin ([see below](#configure-extension)).

### Install manually within the IDE

1. Download the latest release from [GitHub](https://github.com/configcat/intellij-plugin/releases/latest) or from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26096-configcat-feature-flags).
1. In your IDE, open the `File` > `Settings/Preferences` menu.
1. Go to the `Plugin` page and open the `Gear Icon` menu.
1. Select the `Install plugin from disk...` option.
1. In your IDE, open the **File** > **Settings/Preferences** menu.
1. Go to the **Plugin** page and open the **Gear Icon** menu.
1. Select the **Install plugin from disk...** option.
1. Configure the plugin ([see below](#configure-extension)).

### Compatible IDEs
Expand All @@ -68,9 +68,9 @@ The plugin is compatible with the following IDEs. Check the plugin [JetBrains Ma
### Authentication

1. Get your ConfigCat Public API credentials from [ConfigCat Dashboard/Public Management API credentials](https://app.configcat.com/my-account/public-api-credentials).
1. In your IDE, open the `File` > `Settings/Preferences` menu.
1. Search for `ConfigCat Feature Flags` page.
1. Fill out the `Basic auth user name` and `Basic auth password` inputs.
1. In your IDE, open the **File** > **Settings/Preferences** menu.
1. Search for **ConfigCat Feature Flags** page.
1. Fill out the **Basic auth user name** and **Basic auth password** inputs.

<video className="video" controls muted>
<source src="/docs/assets/intellij/auth.mp4" type="video/mp4"/>
Expand All @@ -79,11 +79,11 @@ The plugin is compatible with the following IDEs. Check the plugin [JetBrains Ma

### Advanced

This section is for you if you use a `dedicated hosted`/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you can specify your custom ConfigCat URLs in the IDE.
This section is for you if you use a dedicated hosted/[on-premise](https://configcat.com/on-premise/) ConfigCat instance. In that case, you can specify your custom ConfigCat URLs in the IDE.

1. In your IDE, open the `File` > `Settings/Preferences` menu.
1. Search for `ConfigCat Feature Flags` page.
1. Fill out the `Public Api Base URL` and `Dashboard Base URL` inputs.
1. In your IDE, open the **File** > **Settings/Preferences** menu.
1. Search for **ConfigCat Feature Flags** page.
1. Fill out the **Public Api Base URL** and **Dashboard Base URL** inputs.

- `Public Api Base URL`: the base URL for the ConfigCat Public Management API. Defaults to: https://api.configcat.com.
- `Dashboard Base URL`: the base URL for ConfigCat Dashboard. Defaults to: https://app.configcat.com.
Expand All @@ -92,9 +92,9 @@ This section is for you if you use a `dedicated hosted`/[on-premise](https://con

The ConfigCat Feature Flags Tool Window can be opened by clicking the ConfigCat Feature Flags icon on the side of the IDE main window.

### Feature Flags & Settings Tab
### Feature Flags & Settings tab

After you successfully configured your ConfigCat account in the `Settings`, you can use the Feature Flags & Settings Tab and:
After you successfully configured your ConfigCat account in the **Settings**, you can use the **Feature Flags & Settings** tab and:

- View all of your Products, Configs and Feature Flags.
- Create new Configs and Feature Flags.
Expand All @@ -110,41 +110,41 @@ After you successfully configured your ConfigCat account in the `Settings`, you
#### Create a new Feature Flag

1. Select the Config in the tree where you want to create your new flag.
1. Click the `+` button on the action bar to open the create dialog.
1. Click the **+** button on the action bar to open the **Create Flag** dialog.
1. Select the setting type.
1. Enter the new Feature Flag name.
1. Enter the new Feature Flag key.
1. Add a hint to your Feature Flag (optional).
1. Select 'OK' to confirm the Flag creation.
1. Select **OK** to confirm the Flag creation.

#### Copy a Feature Flag's key to the clipboard

1. Select the Feature Flag in the tree whose key you want to copy.
1. Click the `Copy` button on the action bar to copy the key to the clipboard.
1. Click the **Copy** button on the action bar to copy the key to the clipboard.

#### Open your Flags on the ConfigCat Dashboard
#### Open your Feature Flags on the ConfigCat Dashboard

1. Select the Flag you want to open in the Dashboard.
1. Click the `Open Config in ConfigCat Dashboard` button on the action bar.
1. In the tree, select the Feature Flag you want to open in the Dashboard.
1. Click the **Open Config in ConfigCat Dashboard** button on the action bar to open the Feature Flag in the Dashboard.

#### Find your Feature Flag's usages in your code

1. Select the Feature Flag in the tree you want to search.
1. Click the `Find Usage` button on the action bar.
1. Click the **Find Usage** button on the action bar.
1. See the search results in the opened dialog.

#### Create a new Config under a product

1. Select the Products in the tree where you want to create your new config.
1. Click the `+` button on the action bar to open the create dialog.
1. Click the **+** button on the action bar to open the **Create Config** dialog.
1. Enter a name for the new config.
1. Add a hint to your config (optional).
1. Select `OK` to confirm the Config creation.
1. Select **OK** to confirm the Config creation.

#### Open your Configs on the ConfigCat Dashboard

1. Select the Config which you want to open in the Dashboard.
1. Click the `Open Config in ConfigCat Dashboard` button on the action bar.
1. Click the **Open Config in ConfigCat Dashboard** button on the action bar to open the Config in the Dashboard.

:::info
The actions are available by right click menu as well.
Expand Down
20 changes: 10 additions & 10 deletions website/docs/integrations/jira.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ This integration is for Jira Cloud. It does not work on Jira Data Center or Jira
## Installation

1. Add <a href="https://marketplace.atlassian.com/1222421" target="_blank">ConfigCat Feature Flags</a> to your Jira Cloud instance.
2. Select `Configure`.
2. Select **Configure**.
3. Copy your ConfigCat Public API credentials to the inputs. Read more about <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Public API credentials here</a>.
4. Click authorize.
4. Click **Authorize**.

:::info
Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat Feature Flags Plugin.
Expand All @@ -35,8 +35,8 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
### Linking existing feature flags

1. Navigate to any Issue on your Jira board.
2. Open the `ConfigCat Feature Flag` issue context.
3. On the `Link existing` tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue.
2. Open the **ConfigCat Feature Flag** issue context.
3. On the **Link existing** tab, select a ConfigCat Product, Config, Environment, and Feature Flag to be linked to your Issue.
4. When linked, you can manage the selected feature flag from this Issue.

<video className="video" controls muted>
Expand All @@ -47,8 +47,8 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
### Creating new feature flags

1. Navigate to any Issue on your Jira board.
2. Open the `ConfigCat Feature Flag` issue context.
3. On the `Create and Link` tab, select a ConfigCat Product and Config where you want to create the feature flag.
2. Open the **ConfigCat Feature Flag** issue context.
3. On the **Create and Link** tab, select a ConfigCat Product and Config where you want to create the feature flag.
4. Set up your feature flag.
5. Select which environment you would like to link to this item.
6. When linked, you can manage the selected feature flag from this Issue.
Expand All @@ -61,9 +61,9 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
### View and Edit linked feature flags

1. Open an Issue on your Jira board with a linked feature flag.
2. See the linked feature flags in the `Feature Flag (ConfigCat)` issue section.
2. See the linked feature flags in the **Feature Flag (ConfigCat)** issue section.
3. You can manage the selected feature flag from this Issue.
4. You can add new Percentage Options to Feature Flags or Targeting Rules.
4. You can add new Targeting Rules or Percentage Options to Feature Flags.
5. You can add new Targeting Rules with User, Segment or Prerequisite Conditions with a large selection of Comparators. [Read more about Targeting.](../targeting/targeting-overview.mdx)
6. You can remove Targeting Rules as well.

Expand All @@ -75,7 +75,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
### Remove linked feature flags

1. Open an Issue on your Jira board with a linked feature flag.
2. Remove the linked feature flag by opening the "More menu" and selecting the "Remove from Issue" option.
2. Remove the linked feature flag by opening the **More menu** and selecting the **Remove from Issue** option.

<video className="video" controls muted>
<source src="/docs/assets/jira/remove-ff.mp4" type="video/mp4"/>
Expand All @@ -85,7 +85,7 @@ Every Jira user must authorize ConfigCat in Jira who wants to use the ConfigCat
### View flag status in Releases

1. Open an Issue on your Jira board with a linked feature flag.
2. Check the `Releases` field values in the issue Details section to see the linked feature flags status in the Issue.
2. Check the **Releases** field values in the issue **Details** section to see the linked feature flags status in the Issue.
3. Click it for a more detailed dialog.

<video className="video" controls muted>
Expand Down
20 changes: 10 additions & 10 deletions website/docs/integrations/monday.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This guide will help you with the plugin installation and familiarise you with t
3. Add the ConfigCat Feature Flags monday app to your Item.
4. To use ConfigCat Feature Flags, you must first authorize it with your ConfigCat Public API credentials.
5. Copy your ConfigCat Public API credentials to the inputs. Read more about <a href="https://app.configcat.com/my-account/public-api-credentials" target="_blank">ConfigCat Public API credentials here</a>.
6. Click authorize.
6. Click **Authorize**.

:::info
Every monday.com user must authorize ConfigCat in monday.com who wants to use the ConfigCat Feature Flags app.
Expand All @@ -32,8 +32,8 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th

### Linking existing feature flags

1. Open any item on your monday.com board.
2. Push the `Link existing feature flag`.
1. Open any Item on your monday.com board.
2. Push the **Link existing feature flag** button.
3. Select a Product, Config, Environment, and Feature Flag to be linked to your monday.com Item.
4. When linked, you can manage the selected feature flag from this monday.com Item.

Expand All @@ -44,8 +44,8 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th

### Creating new feature flags

1. Open any item on your monday.com board.
2. Push the `Create and link feature flag`.
1. Open any Item on your monday.com board.
2. Push the **Create and link feature flag** button.
3. Select a Product and Config where you want to create the feature flag.
4. Set up your feature flag.
5. Select which environment you would like to link to this Item.
Expand All @@ -58,10 +58,10 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th

### View and Edit linked feature flags

1. Open any item on your monday.com board.
2. See the linked feature flags in the `Feature Flag (ConfigCat)` view.
1. Open any Item on your monday.com board.
2. See the linked feature flags in the **Feature Flag (ConfigCat)** view.
3. You can manage the selected feature flag from this Item.
4. You can add new Percentage Options to Feature Flags or Targeting Rules.
4. You can add new Targeting Rules or Percentage Options to Feature Flags.
5. You can add new Targeting Rules with User, Segment or Prerequisite conditions with a large selection of Comparators. [Read more about Targeting.](../targeting/targeting-overview.mdx)
6. You can remove Targeting Rules as well.

Expand All @@ -72,8 +72,8 @@ Every monday.com user must authorize ConfigCat in monday.com who wants to use th

### Remove linked feature flags

1. Open any item on your monday.com board with a linked feature flag.
2. Remove the linked feature flag by opening the "More menu" and selecting the "Unlink" option.
1. Open any Item on your monday.com board with a linked feature flag.
2. Remove the linked feature flag by opening the **More menu** and selecting the **Unlink** option.

<video className="video" controls muted>
<source src="/docs/assets/monday/remove_ff.mp4" type="video/mp4"/>
Expand Down
Loading