Aurinko
Aurinko websiteAurinko blogAPI ReferenceContact Support
Aurinko API
Aurinko API
  • Getting started
    • What is Unified Mailbox API?
    • Getting started with Aurinko
    • Get your developer API keys
    • Adding Aurinko to Google Workspace allowlist
    • Bubble.io plugin
    • Team members and roles in applications
  • Unified APIs
    • Email API
    • Calendar API
    • Contacts API
    • Tasks API
    • Webhooks API
      • Configuring Pub/Sub for Gmail API Webhooks
    • Direct API
  • Authentication
    • OAuth Flow
      • Account OAuth Flow
      • User ОАuth Flow
      • Service Account OAuth Flow
    • Authentication scopes
    • Authorized return URLs
    • Google OAuth setup
    • Office 365 OAuth setup
    • ZOHO OAuth setup
    • Service accounts
      • Setting up G Suite service account
      • Setting up Office 365 daemon app registration
  • Scheduling
    • Create your first appointment booking page
    • Calendar Booking Page
    • Booking API
    • Group Booking API
  • Workspace Addons
    • Outlook addins
      • Create your first Outlook addin
      • Office 365: Installing Outlook addin
    • Microsoft Teams apps
      • Microsoft Teams bot setup
      • Create your first MS Teams app
      • Installing MS Teams app
    • Chrome Extensions with Google authentication
    • Google Workspace Add-Ons
  • Dynamic API
    • What is Dynamic (Virtual) API?
    • Getting Started with Dynamic API
Powered by GitBook
On this page
  1. Unified APIs
  2. Webhooks API

Configuring Pub/Sub for Gmail API Webhooks

Set up Google Cloud Pub/Sub for Aurinko to receive Gmail API push notifications, eliminating constant polling and enhancing efficiency.

PreviousWebhooks APINextDirect API

Last updated 8 months ago

This guide explains how to set up Google Cloud Pub/Sub (Pub/Sub) for Aurinko to receive push notifications from the Gmail API. Using Pub/Sub eliminates the need for constant polling of your Gmail inbox for updates, improving efficiency.

To get started, head over to . You will be prompted to log in with a Google account if you're not already logged in with one.

Select your project, or create a new one. Refer to if creating a new project, the Gmail API needs to be enabled!

Pub/Sub topic setup


  1. Head over to the Pub/Sub page

  1. Create a new topic. The default options will do:

  1. Copy the topic name and enter it in your Aurinko app settings:

  1. Back in the Google Developer console, edit the default subscription that was created for your new topic. Make it a Push subscription with the following 'Endpoint URL': https://api.aurinko.io/push/google/email/{clientId}

Also, change the retry policy and save:

  1. Go back to the 'Topics' menu and click 'View permissions' for your new topic.

  1. Now, let's grant Gmail privileges to publish notifications to your topic.

Click 'ADD PRINCIPLE' and grant publish privileges to gmail-api-push@system.gserviceaccount.com:

You are done!

https://console.developers.google.com
this article