Webhooks

Pathfix Automation has pre-configured webhook connections to a few providers, this makes it easy for you to be able to connect, start listening for webhook events for each provider and add the integration to your platform.

For provider specific webhook setup guide, click here.



Activating Webhooks

Make sure you have added the provider integration in your Pathfix OAuth account first before proceeding. Here is the setup documentation for Pathfix OAuth platform.

Introduction

Once a webhook has been configured, you can trigger any Pathfix automation built. Alternatively, you can also trigger your own endpoint to perform a function of your choice.

Create a blank automation

Before proceeding to configure a webhook, create a blank automation first. This will allow you to capture the incoming data and configure your automation later.



• Click on Design and select

Create new automation





• Give your Automation a name to save the automation



Name the automation



• 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







Enable Webhook

• Click on Webhooks from the top nav bar
• From the list of providers, select the provider you wish to enable the webhook for



Create new webhook





• In the General tab, enter the Callback URL copied from the blank automation created. The Webhook data received will be sent to this automation
• The next fields will define any provider-specific requirements. Each provider has a different webhook requirement and differs from provider to provider. Please make sure you check the notes under each item for details

Provider specific setting





• Click on Pathfix OAuth tab
• Enter your Pathfix Public Key and Private Key (get this from your Pathfix OAuth platform -> Application - Keys)

Pathfix OAuth setup





Save the settings.

Some providers request for a Webhook URI to be entered in the developer portal of the app. Copy the webhook url from your Pathfix Automation account and paste it in the providers developer portal (in most cases, this would be under the Webhook/Callback URL section).

Click on Activate to activate the webhook and wait for a few minutes for the red dot to turn green. This would indicate that the webhook has been enabled and is now listening for events sent by the provider.



Copy Webhook URI and Activate





Go to your Pathfix OAuth account and click on Test Connection of the configured provider (in this case, Twitter).

Test your connection





Connect/Re-connect your twitter account



Connect your account



Pathfix Automation will validate the webhook and register it for each of your connected user.



Check Webhook Receipt

Open the Monitor in Pathfix Automation and browse through the completed runs of "Twitter Catch All" automation

See the request section (this will give you a sample JSON that you can use in your further automation setup)



Monitor





Status and Users

• Once successfully setup, you will see:
  • Status against the activated webhook (Green or Red)
  • Total number of users that have subscribed to the webhook
  • Option to Deactivate the webhook



Image: Webhook status





• To view details of the users connected, click on the Subscribed Users count
• You will see a list of all connected users

Image: Connected users





• If there are any failures against a user, click on the refresh icon and the webhook will try to re-register the user automatically

Image: Failed reconnection





Supported Providers

Below is the list of currently supported providers for webhook.

Provider support is added based on customer requests. If you are looking for a provider that is not on this list, do reach out to us via chat or email (support@pathfix.com) and we will look into adding webhook support for the provider.

1. Facebook
2. Gmail
3. Google Calendar
4. Google My Business
5. Microsoft Calendar
6. Microsoft Defender
7. Microsoft Graph
8. Microsoft Mail
9. Salesforce
10. Shopify
11. Slack V2
12. Stripe
13. Twitch
14. Twitter
15. Xero







Need help? You can always reach out to our support team for any additional assistance at support@pathfix.com.