You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<Info>Feature available in <ahref="https://tableflow.com/pricing"target="_blank">TableFlow Cloud</a>.</Info>
18
18
19
-
TableFlow provides an API to paginate the row data of an import, view metadata about an import, or download an import directly as a CSV.
19
+
TableFlow provides an API to retrieve import data, paginate the row data of an import (used for large imports), or download an import directly as a CSV.
You can also use [Webhooks](/webhooks) to get notified when an import has been completed. This allows your backend application to load the imported data as soon as an import has completed.
Copy file name to clipboardExpand all lines: docs/webhooks.mdx
+44-1Lines changed: 44 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,9 @@ TableFlow uses webhooks to push real-time notifications about your data imports.
8
8
9
9
1. Your user imports a CSV or Excel file using the embedded TableFlow importer on your web app
10
10
2. TableFlow notifies your system, via a webhook, that a data import has been completed
11
-
3. Your system can use the API to [paginate through the imported data](/api-reference/get-import-rows), or [download the data directly as a CSV file](/api-reference/download-import).
11
+
3. The webhook will contain the row data, column definitions, and other information about the import
12
+
13
+
<Info>The number of rows included is limited to 10,000. If there are more than 10,000 rows, an `error` will be set and the data should be retrieved using the [API](/api-reference/get-import-rows).</Info>
12
14
13
15
## Configure your application to receive webhooks
14
16
@@ -39,3 +41,44 @@ You’ll be able to see the webhook received on [Svix Play](https://play.svix.co
39
41
</Frame>
40
42
41
43
After configuring your application to receive webhooks, all subscribed events will be sent to the endpoint. You can now import a file to test out your new webhook!
44
+
45
+
## Transforming and filtering webhooks
46
+
47
+
You can use the transformations feature to modify the payload of webhooks or cancel it entirely based on data in the payload.
48
+
49
+
To add a transformation, select "Enable" and "Edit transformation" under the "Advanced" tab of an endpoint:
To filter webhooks from being sent to an endpoint, you just need to set `webhook.cancel = true`. In this example we filter webhooks to an endpoint based on the import `metadata` (a parameter you can provide the [SDK](/sdk/react#properties)):
0 commit comments