createIntegrationSetting

Requires permission settings:integration:create.

Sets up an integration for a service. The configuration must be valid for that service, and a service can only be set up once. When it is created switched on, it is validated straight away. Requires permission to create integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CreateIntegrationSetting($input: CreateIntegrationSettingInput!) {
  createIntegrationSetting(input: $input) {
    id
    displayName
    serviceName
    createdAt
    config
    description
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CreateIntegrationSetting($input: CreateIntegrationSettingInput!) {\n  createIntegrationSetting(input: $input) {\n    id\n    displayName\n    serviceName\n    createdAt\n    config\n    description\n  }\n}",
  "variables": {
    "input": {
      "config": {},
      "displayName": "string",
      "isEnabled": true,
      "priority": 0,
      "serviceName": "AMAZON",
      "tags": [
        "string"
      ],
      "version": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "config": {},
    "displayName": "string",
    "isEnabled": true,
    "priority": 0,
    "serviceName": "AMAZON",
    "tags": [
      "string"
    ],
    "version": "string"
  }
}

Response:

{
  "data": {
    "createIntegrationSetting": {
      "id": "id",
      "displayName": "string",
      "serviceName": "AMAZON",
      "createdAt": "2025-01-15T00:00:00Z",
      "config": {},
      "description": "string"
    }
  }
}

createIntegrationSetting(
  input: CreateIntegrationSettingInput!
): IntegrationSetting!

Arguments

createIntegrationSetting.input ● CreateIntegrationSettingInput! non-null input

The service, its configuration and credentials, and whether it is switched on.

Type

IntegrationSetting object

An integration setting.