COconfigcat
Integrations

Create Integration

Changed on

This endpoint creates a new Integration in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint.

The Parameters dictionary differs for each IntegrationType:

  • Datadog
    • apikey: Required. Datadog API key.
    • site: Datadog site. Available values: Us, Eu, Us1Fed, Us3, Us5. Default: Us.
  • Slack
    Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook.
    • incoming_webhook.url: Required. The incoming webhook URL where the integration should post messages.
    • includeSensitiveData: Set to "true" to include sensitive (hashed) comparison values. By default, the integration will mask these values in the posted messages. We recommend hiding sensitive comparison values for shared or public Slack channels.
  • Amplitude
    • apiKey: Required. Amplitude API Key.
    • secretKey: Required. Amplitude Secret Key.
  • Mixpanel
    • serviceAccountUserName: Required. Mixpanel Service Account Username.
    • serviceAccountSecret: Required. Mixpanel Service Account Secret.
    • projectId: Required. Mixpanel Project ID.
    • server: Mixpanel Server. Available values: StandardServer, EUResidencyServer. Default: StandardServer.
  • Twilio Segment
    • writeKey: Required. Twilio Segment Write Key.
    • server: Twilio Segment Server. Available values: Us, Eu. Default: Us.
  • PubNub (work in progress)
post/v1/products/{productId}/integrations

Request

Path parameters

productIdstring uuid required

The identifier of the Product.

Request body

integrationType'dataDog' | 'slack' | 'amplitude' | 'mixPanel' | 'segment' | 'pubNub' required
namestring required

Name of the Integration.

parametersobject required

Parameters of the Integration.

environmentIdsstring[] required

List of Environment IDs that are connected with this Integration. If the list is empty, all the Environments are connected.

configIdsstring[] required

List of Config IDs that are connected with this Integration. If the list is empty, all the Configs are connected.

Response

When the creation was successful.

integrationIdstring uuid required

Identifier of the Integration.

namestring required

Name of the Integration.

integrationType'dataDog' | 'slack' | 'amplitude' | 'mixPanel' | 'segment' | 'pubNub' required
parametersobject nullable required

Parameters of the Integration.

environmentIdsstring[] required

List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected.

configIdsstring[] required

List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected.

Changes

  • fc2e575e2bd3Revision changes
    • info

      added the required property / to the response with the status

  • ce2ecdf9eea6Revision changes
    • breaking

      the request property / became not nullable (media type: application/json)

    • breaking

      the request property / became not nullable (media type: text/json)

    • breaking

      the request property / became not nullable (media type: application/*+json)

    • warning

      the request property's maxLength was set to 255 (media type: application/json)

    • warning

      the request property's maxLength was set to 255 (media type: text/json)

    • warning

      the request property's maxLength was set to 255 (media type: application/*+json)