Webhooks
Receive webhooks when records are created, updated, or deleted from your Sync.
Configuring your Webhook URL
You can set up your Webhook URL in the Paragon dashboard to start receiving events about your Syncs.
Navigate to the Syncs page in the dashboard to set your Webhook URL for a specific Paragon project:
Your Webhook URL must respond to POST
requests with a 2xx HTTP status in a timely manner. If your webhook fails to respond repeatedly, we may disable your webhook.
Receiving Webhook Events
All webhook events will be sent to your configured Webhook URL as a POST
request.
Each webhook event will include the following standard properties to identify the related Sync and User:
Event Types
The full list of possible event
type values are as follows:
sync_complete
sync_errored
record_created
record_updated
record_deleted
record_errored
sync_complete
This event is sent when an Initial Sync has completed successfully.
sync_errored
This event is sent when a Sync has failed and cannot continue. After this event is sent, the Sync status
field will be set to ERRORED
.
record_created
This event is sent when a Sync has discovered a new record (determined by a permanent ID or path available in the integration provider) during its Incremental Sync.
Create events do not provide any record data as a part of the event payload, but you can use the Get Synced Record endpoint to get the latest data.
record_updated
This event is sent when a Sync has discovered an update to an existing record during its Incremental Sync.
Update events do not provide any record data as a part of the event payload, but you can use the Get Synced Record endpoint to get the latest data.
record_deleted
This event is sent when a Sync has discovered that a record has been deleted or is otherwise unavailable to the connected account (for example, the record’s access has been revoked from your user).
When records are deleted, the contents of their metadata are removed from the Sync, and you can no longer retrieve the synced object or its associated file data. However, the Pull Synced Records endpoint will provide a sparse entry with the id
and external_id
property for visibility on the deletion.
These events are sent after a successful Periodic Full Sync.
record_errored
This event is sent when a Sync has encountered an error while processing a record (for example, fetching permission data for this record). This event does not affect the Sync’s status
field, and the Sync will continue processing other records.