Platform User Manual
[Mzima] User Manual
[Mzima] User Manual
  • [Mzima] Ushahidi Platform User Manual
  • Navigating the Ushahidi Platform User Manual
  • Downloading the User Manual
  • Translating the User Manual
  • About Ushahidi
  • Overview of Ushahidi Platform [Mzima]
    • Technical Specifications
  • 1. Installing Ushahidi Platform
  • 2. Setting up a deployment
  • 3. Configuring your deployment
    • 3.1 Accessing your deployment
    • 3.2 General Settings
    • 3.3 Surveys
    • 3.4 Data Sources
      • 3.4.1 Email
      • 3.4.2 Gmail
      • 3.4.3 Vonage(formerly NextMo)
      • 3.4.4 SMSSync
      • 3.4.5 Twilio
      • 3.4.6 Twitter
      • 3.4.7 Africa's Talking
    • 3.5 Categories
  • 4. Managing People on your deployment
    • 4.1 Roles
    • 4.2 Users
  • 5. Modes for visualizing and managing data on your deployment
    • 5.1 Map View
    • 5.2 Data view
    • 5.3 Activity view
    • 5.4 Data managing functionalities shared among views
  • 6. Managing Data in your deployment
    • 6.1 Viewing Posts
    • 6.2 Filtering and Sorting Posts
    • 6.3 Adding Posts
    • 6.4 Editing Posts
    • 6.5 Translating Posts
    • 6.6 Publishing Posts
    • 6.7 Deleting Posts
    • Page
    • 6.8 Importing Data
    • 6.9 Exporting and Tagging Data
      • 6.9.1 Exporting Data
      • 6.9.2 Tagging Data - HDX integration
  • 7. Analysing Data on your deployment
    • Untitled
    • 7.1 Saved Searches
    • 7.2 Collections
  • 8. Additional Links
Powered by GitBook
On this page
Export as PDF
  1. 3. Configuring your deployment
  2. 3.4 Data Sources

3.4.2 Gmail

Previous3.4.1 EmailNext3.4.3 Vonage(formerly NextMo)

Last updated 1 year ago

This data source is not available in your deployments. You will not find it in your settings, please reach out to support@ushahidi.com or our chat messenger to enable it in your deployment.

This section allows you to set up the platform to receive and send emails through a connected Gmail account via the API. Before getting started, make sure that you have an email account set up on Gmail. Note: If you're self hosting the Ushahidi platform, the Gmail Provider makes use of the server-side flow when making a request to Gmail API, and must be authorized using OAuth 2.0 Credentials.

Follow this guide to create the OAuth 2.0 Credentials (Client ID and Client Secret) with . Keep in mind:

  • Select "where you will be calling the API from" as Other UI.

  • Select User data as the data type to be accessed.

  • Select your application type as TVs and Limited Input devices.

  • There's a need to set up a consent screen.


To get started with Gmail set up on the Ushahidi platform, click on Gmail from the drop down as shown below.

Input the following email account settings

  • Email Address: Enter the Gmail address you will be receiving and sending emails with.

  • Fetch Email From: Pick the date you want to start fetching messages from.

  • Client Id: Enter the Gmail client id gotten from the OAuth credentials.

  • Client Secret: Enter the Gmail client secret gotten from the OAuth credentials.

  • Redirect URL: Enter the redirect URL from the OAuth credentials. The default value set here is urn:ietf:wg:oauth:2.0:oob and in most cases should be left this way.

  • Click on Save and this data source’s settings will be saved.

The below setup will be available to both the hosted and self-hosted users.

  • Next, Scroll up and click on Connect your Gmail Account and this will show a google prompt to authenticate your Gmail account.

  • Follow the prompt through and click on Allow to be presented with the list of Gmail accounts that you have.

  • Grant permission by selecting the Gmail account that you would like the Ushahidi platform to access.

  • This will display an auth code.

  • Please copy the provided code, switch back to your Ushahidi application, and paste/enter it on the opened modal:

  • Enter the point in time that you would like the Ushahidi platform to fetch messages from your inbox.

  • Click on Authorize to save the auth code and date entered.

  • A message will be displayed in your deployment to indicate that your account is connected, messages from Gmail will now be pulled into the platform via the API.

  • To disconnect your account, simply click on Disconnect your Gmail account to stop all messages from being fetched from your inbox.

NB: All messages that were previously fetched will not be deleted from your deployment.

  • To enable/disable the email data source, simply click on the green toggle and click on save.

Gmail
List of available data sources - red arrow pointing to Gmail Data Source
Connect Your Gmail Account button displayed to prompt for authentication
External Gmail Authentication Page - Red arrow pointing to allow for ushahidi to access google account
Select an account from the list of Gmail accounts you have
Coonect Your Gmail Account Page - Enter Auth Code, Sync Date and then authorize or cancel
Disconnect Your Gmail Account to stop all message from being fetched
Edit Gmail Data Source Page - Import to Basic Post highlighted
List of available data sources - red arrow pointing to Gmail Data Source
Edit Gmail Data Source Page - Import to Basic Post highlighed.
External Gmail Authentication Page - Red arrow pointing to allow for ushahidi to access google account
Connect Your Gmail Account button displayed to prompt for authentication to your Gmail Account
Coonect Your Gmail Account Page - Enter Auth Code, Sync Date and then authorize or cancel
Choose An Account - Select an account from the list of Gmail accounts you have
Disconnect Your Gmail Account to stop all message from being fetched