Skip to content

Initial Setup: Pub Sub & Frappe

Shivam Saini edited this page Sep 8, 2025 · 3 revisions

Initial Setup: Pub/Sub & Frappe

Once your Google Cloud project is configured, you can set up the Pub/Sub topic and the Frappe app.

Step 1: Gmail Pub/Sub Setup

  • Go to Pub/Sub Topics and create a new topic.

  • Give it a Topic ID.

  • Select the Add a default subscription checkbox.

  • image3
  • Next, edit the default subscription.

  • image9
  • Change the delivery type to Push.

  • Set the Endpoint URL to <BASE_URL>/api/method/frappe_gmail_thread.api.pubsub.callback.

  • image14
  • Finally, go back to the topic page, add permissions to the topic (not to the subscription):

    • Principal: gmail-api-push@system.gserviceaccount.com
    • Role: Pub/Sub Publisher
  • image6
  • image8
  • Save the topic name (from the subscription) for later use.

  • image13

Step 2: Install and Configure the Frappe App

  • Install the app using the Bench CLI:

    bench get-app git@github.com:rtCamp/frappe-gmail-thread.git
    bench install-app frappe_gmail_thread
    
  • Log in as an administrator in Frappe and go to Google Settings.

  • Enable Google API.

  • Enter the Client ID and Client Secret you saved earlier.

  • Under Gmail Settings, enable Sync in Realtime and add the Pub/Sub Topic you created.

  • image7
  • image10

Clone this wiki locally