IntegrationActivation

A newly activated integration with one-time setup instructions.

Returned by createIntegration and enableIntegration. The instructions field contains setup steps that may include sensitive credentials (e.g., IAM role trust policies, webhook URLs). These instructions are only available at activation time and should be stored securely.

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

Fields

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

The integration type identifier, unique within your organization.

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

The type of this integration (same as id).

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

Integration-specific configuration values.

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

Current lifecycle status (typically enabling or enabled).

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

When this integration was first created (UTC).

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

When this integration was last modified (UTC).

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

When this integration is next scheduled to execute (UTC), if applicable.

IntegrationActivation.instructions ● String! non-null scalar {#instructions}

One-time setup instructions for completing the integration. May contain sensitive credentials such as IAM trust policies or webhook secrets — store these securely.

Member Of

IntegrationActivationPayload object