Documentation Integrations Integration Detail
Detailed guide

Integration Detail

The service-specific control page for one integration (for example Xero), including connection health, sync settings, and credential lifecycle checks.

Integration Detail isolates one external service so you can fix that connection without disturbing others. In the Xero example, this is the operational checkpoint for OAuth connection state, sync readiness, and error diagnosis before finance handoff.

Open demo page Back to overview
Quick summary Step by step Guardrails Troubleshooting Related workflows

Quick summary

  • Review the health indicators before changing configuration values.
  • Re-authenticate Xero when tokens expire or tenant authorization changes.
  • Validate sync settings before month-end or invoice-export cycles.

Put it into practice

  1. Start by confirming you are on the Xero integration record and check connection state first. This avoids editing fields when the real issue is expired or revoked authorization.

    InteractionsIntegration Detail header and status area: verify service name (Xero) and current connection state.

  2. Review current sync settings and account mapping context before reconnecting. Preserve valid settings and only change what explains the observed sync issue.

    InteractionsConfiguration fields area: inspect sync toggles and mapping-related controls.

  3. If disconnected or stale, run reconnect/authorize flow and confirm success state returns. Treat partial authorization as unresolved until status is clearly healthy.

    InteractionsReconnect/authorize controls on the Integration Detail page for Xero.

  4. Run or observe the next sync cycle and inspect diagnostics. Validate that expected invoice or accounting data moves cleanly without new warnings.

    InteractionsSync status/diagnostics panel: check latest run result, timestamp, and any returned error detail.
    Open workflow: Invoice Workflow

  5. If issues persist, verify workspace user/role access for integration maintenance so credential and config actions are being executed by authorized admins.

    InteractionsWorkspace admin area: confirm integration-management access scope before retrying connection changes.
    Open workflow: Roles

What to review

Service header

Confirms which external service you are editing so you do not apply settings to the wrong connection.

Configuration fields

These values determine how MarginPlan talks to the external service.

Status or sync information

Use this to judge whether the connection is healthy or needs investigation.

Save or reconnect actions

Apply configuration updates or re-establish the service link when needed.

OAuth connection state

For Xero, confirms whether authorization is active, expired, or disconnected so you can choose reconnect vs. settings edits correctly.

Sync diagnostics and last-run context

Use latest sync status, timestamps, and error context to determine whether issues are credential, mapping, or payload related.

Guardrails

  • Service-specific settings must validate before the integration can be trusted.
  • For Xero, connection status should be healthy before relying on export/reconciliation workflows.
  • Sync diagnostics should be reviewed after reconnect or settings changes to confirm behavior actually improved.
  • Only admins should manage external connections.
  • Xero credential and reconnect operations should be limited to trusted finance or platform admins.

If it starts drifting

  • If status remains unhealthy after save, verify the external service credentials or endpoint rather than changing random local fields.
  • If reconnect appears successful but sync still fails, inspect mapping assumptions and the latest sync diagnostics before reconnecting again.
  • If authorization keeps expiring, verify the correct Xero tenant/account was used and that no policy revocation occurred externally.