Form Data Export API
To use Form Data Exports, an Export must be created in the Control Center. This determines which form to export data for, and what data should be exported.
When an Administrator wants to run the export, Jadu Central will create a Job based on the export, and add this to a queue. The queue processes it, generating Export Files.
Jadu Central provides an API to allow external applications to interact with Data Export. Through the API, it is possible to:
Callback functionality is also provided, to notify external applications when an Export Job changes status - see API Notifications.
The below diagram illustrates how the API endpoints and callback notifications are related:
Developers must create an API application before accessing the API, in order to obtain a secret access token. This secret access token can be used to make authenticated requests to the API.
It is not currently possible to use the API to set up exports on a schedule. To do this, it is necessary to create an application which calls the Create Job endpoint according to the desired schedule, for instance via a cron tab or scheduled task.