Xkit

The xkit Developer Hub

Welcome to the xkit developer hub. You'll find comprehensive guides and documentation to help you start working with xkit as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

First User Integration - Gmail

Steps to set up Gmail with Xkit if you haven't connected to any Google apps before

📘

Important

This guide walks you through how to set up Gmail if you have not connected to another Google app before.

If you have connected to another Google app already, please see: Gmail as an additional Google integration.

Google's Guide: https://developers.google.com/gmail/api/guides
Authorization protocol: OAuth 2.0

1. Add the Gmail connector in the Xkit platform.

  • In the Xkit platform, click "New connector" in the sidebar or at the bottom of the "Connectors" screen.
  • Click "Gmail". At this point you'll see a callback url, which you'll provide to Google in one of the following steps, and places to input the Client ID and Client Secret that you'll get from Google after registering your app with them.

2. Register your application with Google.

  • Next, in a separate window, sign in to your Google account.
  • Visit the Google API Console.
  • Click "CREATE PROJECT", enter the name of your application and click "CREATE".

3. Enable the Gmail API.

  • From the Google API console, click "ENABLE APIS AND SERVICES".
  • Search "Gmail" and click on it.
  • Click "ENABLE".

4. Set the permissions/scopes.

  • From the Google API Console dashboard, click "OAuth consent screen" in the sidebar and submit the requested general information about your application.
  • Under "Scopes for Google APIs", select the permissions/scopes your application requires (additional details about the scopes are available here).
  • Click "Add".
  • Complete the remaining general information and click "Save".

5. Provide Gmail with the callback url.

  • Click "Credentials" in the sidebar.
  • Click "Create Credentials" and then "OAuth client ID" in the dropdown.
  • Input the requested information about your app, including copying/pasting the callback URL from the Xkit platform into the "Authorized redirect URIs" field on the Google page.
  • Click "CREATE".

6. Provide Xkit with the credentials.

  • After completing the last step, you should see the credentials you just created under "OAuth 2.0 Client IDs". Click this to see details.
  • Copy/paste your Client ID and Client secret onto the Xkit page.

7. Submit your application information for verification.

  • Click "OAuth consent screen" in the sidebar, "EDIT APP" and then "Submit for verification".

8. Complete the Xkit connection setup.

  • Now that you've provided the callback URL to Google and entered the Client ID and Client Secret into the Xkit platform, click "Save" on the Xkit page.
  • Fill out the Catalog Settings page and again click "Save".
  • On the next page, select the same permissions/scopes you entered into Gmail and click "Save".

You've now successfully connected Gmail with Xkit!

Updated 7 days ago

First User Integration - Gmail


Steps to set up Gmail with Xkit if you haven't connected to any Google apps before

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.