Google Calendar Webhook

Through Pathfix Automation, you can enable user webhook listening for all your user that have connected their Google Calendar account via Pathfix OAuth.

The following documentation will guide you on how you can setup your Google Dev Console account and setup Google Calendar Webhook listening for all your connected users.



Setup in Pathfix OAuth

Before proceeding, make sure you have setup your Google Calendar integration in Pathfix OAuth and have added the Connect button for your users to be able to connect their Google Calendar accounts.

• Configure your Google Calendar integration in Pathfix OAuth
• Add the script tag in your application to allow your users to connect their Google Calendar accounts
• (Detailed documentation for Pathfix OAuth can be found here)









Setup in Pathfix Automation (Part 1)

The setup with Pathfix Automation and Google Console will require switching between both platforms

• Create a blank automation by clicking on Design and selecting New Design
• Give your first task a name to save the automation (autosave)





• Click on the Test and Publish tab and click on Test to run a test on the automation







• On successful completion, click on Publish to Live





• Click on Endpoints and copy the endpoint url for use in the Webhook setup
• Live Endpoint is for Live environments and Dev endpoint is for testing/development







• Click on Webhooks from the top navigation and click on Create New
• Select Google Calendar from the list of provider webhooks
• Paste the endpoint URL copied from the automation into the Callback URL section
• We will copy the Verification Token from Google Console in the next section for use in the Verify Token section later





• Click on the Pathfix OAuth tab and enter your Pathfix OAuth Public Key and Private Key







• Click to generate the Webhook URI for use in Google Search Console



Setup in Google Search Console (Part 1)

Domain verification is needed in order to get the Google Calendar webhook setup done. This is done through the Google Search Console here: https://search.google.com/search-console

• Click on Add Property to create a new entry







• Select URL prefix and paste the Webhook URI copied from the webhook interface from Pathfix Automation





• Scroll down to the HTML tag section and copy the meta for use in Pathfix Automation webhook setup
• Do not click Verify yet, leave this window open until we are ready to verify (verification will only be done after the setup in Pathfix Automation is completed)







Setup in Pathfix Automation (Part 2)

• In your Automation webhook window, paste the HTML tag copied from Google Search Console to the Verify Token section
• Hit Save







• On the following Webhooks page, click on Activate to activate your webhook







• The webhook activation will take a few minutes and will happen in the background
• Once activated, the webhook status will turn Green (click on the Refresh icon)







Setup in Google Search Console (Part 2)

• Go back to your Google Search Console and click on Verify







You can now go back to the automation built and build out your automation based on the data received for every connected user



Testing Your Webhook Setup

We recommend running a test on your webhook setup to make sure the setup is right. To do this:

• Go to your Pathfix OAuth account and click on Test Connection for Goolgle Calendar
• Click on Connect/Re-Connect and connect a Google Calendar account







• On successful connection, the Automation will start listening for changes in Google Calendar for the connected user
• You will see the webhook user count increase (if it doesnt increase at first, click on Refresh on the top navigation)







• Go to your Google Calendar app and create a test event
• Go to your Pathfix Automation account and click on Monitor
• You should see the test event created would have triggered a webhook call





Your Test is successful.



Configure Your Automation

Now that your webhook has been setup successfully, you will need to copy the payload sent by Google Calendar and captured by Pathfix Automation and create your Automation.

Here are the few initial steps to get you going:

• Copy the Request received from our test event







• Go to the Automation created and paste the Request into the Call data (JSON) section of the first task







• From here, you can call an API, run a condition or process the data as you please through the Automation







• You can use the data received from the webhook received into any of the next calls made. Simply double click on the dynamic fields and select the API name







Important

• Any changes made to the automation will need to be done in the Dev environment
• Once changes are made, you will first have to Test the Automation and on successful completion then Publish to Live
• Please note, without publishing to Live, the changes will not go into effect



Few points to note on the JSON:

1. The pathfix_user_id is the same user Id that is sent via the Pathfix OAuth system. This generally is the Current Users Unique Id
2. the data section of the JSON is the exact data that is sent by Google





Need help? Reach out to our support via support@pathfix.com or live chat through your Pathfix dashboard