What Are Portal 3.0 Compatibility Webhooks?
This feature is enabled per-request. To enable it, please contact your Flatfile Customer Success representative or reach out to support@flatfile.com.
Compatibility webhooks are designed for customers that are using Portal 2.0 and want to fetch uploaded data from Portal 3.0 imports without re-writing their endpoints.
Differences between Portal 2.0 and Portal 3.0 Webhooks
| Portal 2.0 | Portal 3.0 | |
|---|---|---|
| Payload | Metadata and record data | Notifications with metadata only (no record data) |
| Notifications | Multiple notifications for >1,000 rows of data | Single notification for any dataset size, retrived using an API call |
| Events | Only one kind of event, fired at the end of import | Multiple events |
For more information about how to upgrade to Portal 3.0, contact our Customer Success team.
Subscribing to Compatibility Webhooks
To subscribe to a compatibility webhook, click on Flows on the left-hand side of your dashboard. On the Flows page, click on the Embeds tab and then on the embed you would like to receive data from.
Scroll down to the bottom of the page to the Manage webhooks (legacy) section. Here, enter the URL where you would like to receive HTTP POST requests. After entering a URL, you can click Send sample payload to URL to validate that your URL is valid and that your end point is receiving payloads.
Sample Webhook Payload
Frequently Asked Questions
Why is "settings": {"id"} always null?
Because the compatibility webhooks follow the same payload structure as the legacy format, but Portal 3.0 doesn’t require a Settings ID, you’ll find that Settings ID is null, as such:
What is "meta": {length}?
The value assigned to "length" is the number of records submitted in the import.