IntegrationConnection

Schema #/components/schemas/IntegrationConnection of contract 1.0.0-draft.14.

  • id Uuidrequired

  • name stringrequired

  • provider ProviderIdrequired

  • environment ProviderEnvironmentrequired

  • status ConnectionLifecyclerequired

  • role stringrequired

    One of: "primary", "fallback"

  • webhookRegistrationState WebhookRegistrationStaterequired

  • webhookPartnerState WebhookPartnerState | nullrequired

  • healthy boolean | nullrequired

    Last connection test / health check passed.

  • lastHealthAt Timestamp | nullrequired

  • breaker stringrequired

    Circuit breaker from the provider request log (unknown without calls in 10 minutes).

    One of: "closed", "open", "unknown"

  • errorRate1h number | nullrequired

    min 0 · max 1

  • lastEventAt Timestamp | nullrequired

  • lastEventType string | nullrequired

  • eventBacklog integerrequired

    Verified provider events not yet processed.

    min 0

  • oldestUnprocessedAt Timestamp | nullrequired

  • lastReconciliation object | nullrequired

    Fields of lastReconciliation
    • status stringrequired

    • startedAt Timestamp | nullrequired

    • finishedAt Timestamp | nullrequired

  • openReconciliationExceptions integerrequired

    min 0

  • checklist object | nullrequired

    Activation checklist progress (applicable steps); null for the batch rail.

    Fields of checklist
    • complete booleanrequired

    • done integerrequired

      min 0

    • total integerrequired

      min 0