Skip to main content

Integration

A configured integration connecting your organization to an external service.

Each organization can have at most one integration per type. The integration's id corresponds to the integration type (e.g., "aws-cost-and-usage-reports").

type Integration {
id: ID!
integrationTypeId: String!
config: Map!
status: IntegrationStatus!
createdAt: DateTime!
updatedAt: DateTime!
nextRunAt: DateTime
}

Fields

Integration.id ● ID! non-null scalar {#id}

The integration type identifier, unique within your organization.

Integration.integrationTypeId ● String! non-null scalar {#integration-type-id}

The type of this integration (same as id).

Integration.config ● Map! non-null scalar {#config}

Integration-specific configuration values. Structure varies by integration type.

Integration.status ● IntegrationStatus! non-null enum {#status}

Current lifecycle status of this integration.

Integration.createdAt ● DateTime! non-null scalar {#created-at}

When this integration was first created (UTC).

Integration.updatedAt ● DateTime! non-null scalar {#updated-at}

When this integration was last modified (UTC).

Integration.nextRunAt ● DateTime scalar {#next-run-at}

When this integration is next scheduled to execute (UTC). Only present for integrations that run on a periodic schedule. null if the integration is disabled or does not have scheduled runs.

Returned By

integration query

Member Of

IntegrationPayload object ● IntegrationsPage object