Skip to main content

IntegrationSetting

An integration setting.

type IntegrationSetting {
  config: JSON!
  createdAt: DateTime!
  description: String
  displayName: String!
  enteredBy: String!
  id: ID!
  isEnabled: Boolean!
  isValid: Boolean!
  lastValidatedAt: DateTime
  organizationId: String!
  priority: Int!
  serviceName: IntegrationService!
  tags: [String!]!
  updatedAt: DateTime!
  updatedBy: String!
  validationError: String
  version: String!
  webhookUrl: String
}

Fields

`IntegrationSetting.config` ● `JSON!` non-null scalar

The integration's configuration, as JSON.

`IntegrationSetting.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`IntegrationSetting.description` ● `String` scalar

What the integration is for.

`IntegrationSetting.displayName` ● `String!` non-null scalar

The name to show for the integration.

`IntegrationSetting.enteredBy` ● `String!` non-null scalar

The ID of the user who created the record.

`IntegrationSetting.id` ● `ID!` non-null scalar

The unique ID of this record.

`IntegrationSetting.isEnabled` ● `Boolean!` non-null scalar

True when the integration is switched on.

`IntegrationSetting.isValid` ● `Boolean!` non-null scalar

True when the last validation passed.

`IntegrationSetting.lastValidatedAt` ● `DateTime` scalar

When the integration was last validated.

`IntegrationSetting.organizationId` ● `String!` non-null scalar

The ID of the organization the record belongs to.

`IntegrationSetting.priority` ● `Int!` non-null scalar

Which integration wins when several do the same job.

`IntegrationSetting.serviceName` ● `IntegrationService!` non-null enum

The service the integration is for.

`IntegrationSetting.tags` ● `[String!]!` non-null scalar

Tags on the integration.

`IntegrationSetting.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`IntegrationSetting.updatedBy` ● `String!` non-null scalar

The ID of the user who last changed the record.

`IntegrationSetting.validationError` ● `String` scalar

Why validation failed.

`IntegrationSetting.version` ● `String!` non-null scalar

The version of the integration.

`IntegrationSetting.webhookUrl` ● `String` scalar

The webhook address of the integration.

Returned By

createIntegrationSetting mutation ● deleteIntegrationSetting mutation ● enabledIntegrations query ● integrationByService query ● integrationSettings query ● toggleIntegrationEnabled mutation ● updateIntegrationSetting mutation ● validateIntegration mutation

Fields
Returned By