Skip to content

Commit

Permalink
Updated webhooks data retrieval docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ciminelli committed Dec 29, 2023
1 parent 165b8b1 commit aaa7401
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions docs/retrieve-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ onComplete: (data) => console.log(data)

<Info>Feature available in <a href="https://tableflow.com/pricing" target="_blank">TableFlow Cloud</a>.</Info>

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.
TableFlow can send webhooks to your application when an import has been completed. The webhook will contain the row data, column definitions, and other information about the import.

- [Webhook Setup Guide](/webhooks)

TableFlow also 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.

- [Get Import](/api-reference/get-import)
- [Get Import Rows](/api-reference/get-import-rows)
- [Download Import CSV](/api-reference/download-import)

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.


### Option 3: Admin Dashboard

Expand Down
2 changes: 1 addition & 1 deletion docs/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Webhooks

<Info>Feature available in <a href="https://tableflow.com/pricing" target="_blank">TableFlow Cloud</a>.</Info>

TableFlow uses webhooks to push real-time notifications about your data imports. For example, you can use webhooks on TableFlow to get notified when a user completes a file import:
TableFlow uses webhooks to push real-time notifications for your data imports. For example, you can use webhooks on TableFlow to get notified when a user completes a file import:

1. Your user imports a CSV or Excel file using the embedded TableFlow importer on your web app
2. TableFlow notifies your system, via a webhook, that a data import has been completed
Expand Down

0 comments on commit aaa7401

Please sign in to comment.