Information about webhooks from Nango.
POST
endpoint in your app to receive the Nango webhooks"type": "auth"
and "operation": "creation"
. They are sent after a connection has been successfully created.
Payload received following a connection creation:
"type": "auth"
and "operation": "creation"
is necessary. After a connection is created, these webhooks give you the generated connection ID which lets you access the connection later on.Use the values of endUser.endUserId
(and optionally endUser.organizationId
) to reconcile and save the connection ID with the user/org who initiated the connection.authMode
values can be found here. The authMode
value depends on the provider
value.
All operation
values are:
creation
: a new connection has been createdoverride
: a connection has been re-authorizedrefresh
: an OAuth connection’s access token has failed to refreshmodifiedAfter
is an ISO-8601 format string (e.g. 2025-05-21T18:52:49.838Z
) that represents the start time of the last sync. When the webhook target application receives this payload, it should store this value against the connectionId
as a “bookmark”. On the next sync webhook event, use the stored bookmark to retrieve the changed records and store the new modifiedAfter
as the next bookmark. This mechanism ensures that no deltas are missed.
By default, Nango sends a webhook even if no modified data was detected in the last sync execution (referred as an “empty” sync), but this is configurable in your Environment Settings. In case of an empty sync, the responseResults
would be:
syncType
possible values are:
INITIAL
: for the very first execution of a sync.INCREMENTAL
: for subsequent executions of a sync.WEBHOOK
: when an external API webhooks triggers the execution of the sync’s onWebhookPayloadReceived
function.X-Nango-Signature
header.
It’s a SHA-256 hash generated using the secret key found in the Environment Settings in the Nango UI.
The webhook signature can be generated with the following code:
X-Nango-Signature
header value matches the webhook signature.