Skip to content

Authenticate an account and make your first API call

Beginner ⏱ 5 minutes

Follow the guided 3-step process in the admin portal: connect your email provider, copy the integration code, and start syncing emails.

Step 1: Connect your email provider

Open the admin portal and click "Get Started" to begin the guided setup.

Choose your provider:

  • Google: Connect Gmail accounts with full calendar and contacts access
  • Microsoft: Connect Outlook/Office 365 accounts with Teams integration

The admin portal automatically detects your deployment mode and shows you exactly what to do: 1. Create OAuth credentials in your provider's console 2. Copy the provider callback URI exactly as shown 3. Paste your client ID and secret 4. Test the connection

Takes 2 minutes and unlocks the rest of the setup.

Zero configuration needed

The admin portal shows you exactly what to copy from Google Cloud Console or Microsoft Azure. Just follow the step-by-step prompts.

Step 2: Get your integration code

Once your provider is connected, the admin portal shows you the integration code.

The portal automatically generates:

  • Environment variables - API key and base URL for your environment
  • SDK installation - npm install @riposte/sdk
  • Test connection - Simple curl command to verify everything works

Just copy and paste - the portal generates everything you need based on your deployment mode (embedded vs standalone).

Mode-aware instructions

The admin portal automatically detects if you're running embedded or standalone mode and shows the right integration instructions for your setup.

Step 3: Connect your first account

Now you can start syncing real email accounts.

From the admin portal: 1. Click "Connect Account" 2. Enter a user ID (like an email address or database ID) 3. Click "Generate OAuth Link" 4. Open the link and complete the provider login 5. Return to see the account start syncing

That's it! Your first account is now connected and syncing emails. The admin portal shows you the progress and you can start making API calls to fetch the data.

Automatic syncing

Riposte automatically starts syncing historical emails and continues syncing new emails in real-time. Check the logs to see the progress.

Additional resources