integrationSetup.js

Go to the documentation of this file.

export default {
  slug: 'integration-setup',
  title: 'Integration Setup Guide',
  icon: 'settings_input_component',
  summary: 'Step-by-step instructions for setting up Xero, Slack, Mailgun, Office365 Exchange, and SSO for your tenant.',
  sections: [
    {
      heading: 'Overview',
      body: 'This guide walks you through configuring each supported integration for your tenant. Root admins can manage integrations for any tenant, while tenant admins can configure their own.'
    },
    {
      heading: 'Xero Setup',
      steps: [
        { title: 'Go to Integrations', text: 'Navigate to Settings → Integrations in the dashboard.' },
        { title: 'Select Xero', text: 'Choose Xero from the list of available providers.' },
        { title: 'Connect Account', text: 'Click "Connect to Xero" and follow the OAuth flow to authorize access.' },
        { title: 'Configure Sync', text: 'Set sync preferences (invoices, contacts, etc.) and save.' }
      ]
    },
    {
      heading: 'Slack Setup',
      steps: [
        { title: 'Go to Integrations', text: 'Navigate to Settings → Integrations.' },
        { title: 'Select Slack', text: 'Choose Slack from the provider list.' },
        { title: 'Enter Webhook URL', text: 'Paste your Slack Incoming Webhook URL. You can create one in your Slack workspace under "Apps & Integrations".' },
        { title: 'Test & Save', text: 'Click "Test" to send a sample notification, then save your configuration.' }
      ]
    },
    {
      heading: 'Mailgun Setup',
      steps: [
        { title: 'Go to Integrations', text: 'Navigate to Settings → Integrations.' },
        { title: 'Select Mailgun', text: 'Choose Mailgun from the provider list.' },
        { title: 'Enter API Key & Domain', text: 'Paste your Mailgun API key and domain. You can find these in your Mailgun dashboard.' },
        { title: 'Save & Test', text: 'Save your configuration and send a test email to verify.' }
      ]
    },
    {
      heading: 'Office365 Exchange Setup',
      steps: [
        { title: 'Go to Integrations', text: 'Navigate to Settings → Integrations.' },
        { title: 'Select Office365 Exchange', text: 'Choose Office365 Exchange from the provider list.' },
        { title: 'Enter Credentials', text: 'Provide your Office365 SMTP server, username, and password (or OAuth token if supported).' },
        { title: 'Save & Test', text: 'Save your configuration and send a test email to verify.' }
      ]
    },
    {
      heading: 'SSO Setup',
      steps: [
        { title: 'Go to Settings', text: 'Navigate to Settings → SSO.' },
        { title: 'Choose Provider', text: 'Select your SSO provider (Azure AD, Google Workspace, etc.).' },
        { title: 'Enter Metadata', text: 'Paste the SAML metadata or OIDC configuration from your provider.' },
        { title: 'Save & Test', text: 'Save your configuration and test login with a user account.' }
      ]
    },
    {
      heading: 'Tips',
      list: [
        'Root admins can configure integrations for any tenant; tenant admins can only manage their own.',
        'Always test your integration after saving to ensure connectivity.',
        'For SSO, ensure your provider supports SAML or OIDC and that user emails match your tenant domain.'
      ]
    }
  ]
};