Receive webhooks from an API

Step-by-step guide on how to receive webhooks from an API.

External API webhooks let you support real-time updates and are sometimes the only integration option.

Check if Nango supports webhooks for your API

Nango has off-the-shelf support for webhooks coming from this list of APIs.

The Nango team adds webhook support for new APIs in <48h; simply ask in the community.

Configure external webhooks

To send webhooks from an external API to Nango, you need to configure webhooks on the external API portal. For this, you need the Nango URL receiving webhooks, which can be found in your integration settings.

Forward external webhooks to your app

Webhooks received by Nango from external APIs are immediately forwarded to your backend (step-by-step guide to receive webhooks from Nango).

Webhook forwarding is automatically enabled once you send webhooks from external APIs to Nango.

Here is the body of a webhook from Nango forwarding a webhook from an API:

{
   "from": "hubspot",
   "type": "forward",
   "payload": ... // Raw payload from Hubspot wehook

Handle external webhooks in syncs

In addition to webhook forwarding, you can use syncs to handle webhooks to create, update and delete data records in real-time.

Support for specific external webhook subscriptions must be added to each sync individually. You can check if a sync supports external webhooks by selecting your integration, going to the Scripts tab, selecting the sync script, and checking in the sync script settings if it supports webhooks and, if so, which webhook subscription(s).

Each modified record (following an external webhook) will trigger a separate sync webhook from Nango to your app (step-by-step guide to receive webhooks from Nango):

Questions, problems, feedback? Please reach out in the Slack community.