Skip to main content

Create Integration

POST 
/v1/products/:productId/integrations

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.
  • 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)

Request​

Path Parameters

    productId uuidrequired

    The identifier of the Product.

Body

required

    integrationType IntegrationType (string)required

    Possible values: [dataDog, slack, amplitude, mixPanel, segment, pubNub]

    name stringrequired

    Possible values: non-empty

    Name of the Integration.

    parameters

    object

    required

    Parameters of the Integration.

    property name* stringnullable
    environmentIds uuid[]required

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

    configIds uuid[]required

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

Responses​

When the creation was successful.

Schema

    product

    object

    Details of the Product.

    organization

    object

    Details of the Organization.

    organizationId uuid

    Identifier of the Organization.

    name stringnullable

    Name of the Organization.

    productId uuid

    Identifier of the Product.

    name stringnullable

    Name of the Product.

    description stringnullable

    Description of the Product.

    order int32

    The order of the Product represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

    reasonRequired boolean

    Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.

    integrationId uuid

    Identifier of the Integration.

    name stringnullable

    Name of the Integration.

    integrationType IntegrationType (string)

    Possible values: [dataDog, slack, amplitude, mixPanel, segment, pubNub]

    parameters

    object

    nullable

    Parameters of the Integration.

    property name* stringnullable
    environmentIds uuid[]nullable

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

    configIds uuid[]nullable

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

Loading...