Home / Convert Forms / Advanced Features

Export Form Submissions with a Webhook URL

Are you looking for a way to automate exporting your form submissions? With Convert Forms, you can export form submissions by visiting a secret and password-protected webhook URL without logging in first.

Enable the Auto Export Submissions plugin

First, ensure you're using Convert Forms 3.2.10+ Pro, as this is a Pro-only feature. Next, log into your backend, go to System -> Manage -> Plugins, search for "Convert Forms - Submissions Exporter" and click to enable the plugin.

Joomla Form Submissions Exporter

Using the Webhook URL

To export form submissions, you need to visit the following URL:

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions

URL Parameters

Below you can find a list with the supported parameters you can use in the webhook URL to customize the export of your submissions further.

Name Description
secret (required) The Secret Key set in the Security tab on the Convert Forms configuration page.
form_id (required) The ID of the form to export form submissions
filter_period Select submissions created on a certain period or date range. Accepts: today, yesterday, this_week, this_month, this_year, last_week, last_month, last_year, daterange.

Note: All submissions will be exported if no filter period is given.
filter_created_from Select submissions created on or after a specific date. The expected date format is Y-m-d.

Note: To use this option, you must pass filter_period=daterange.
filter_created_to Select submissions created on or before a specific date. The expected date format is Y-m-d.

Note: To use this option, you must pass filter_period=daterange.
filter_search Select submissions that contain the given search term.
filter_timezone By default, all submissions are exported with respect to your site's configured timezone. To export them in UTC time you can use filter_timezone=UTC.
export_type Set whether to export submissions to a CSV or JSON file. Accepts: json, csv. Defaults to csv
export_append If set to true and the export file already contains data, the submissions will be appended. Defaults to false.
export_path The path relative to your site's root directory where to store the export file. It defaults to Joomla's temp directory, usually set to the /tmp/ folder in your site's root directory.
download Set to true to force the download of the export file. The file is automatically deleted after download. 

Examples

Select form #2 submissions received this year and export them to a CSV file.

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions&secret=123&form_id=2&filter_period=this_year

Select form #3 submissions received today and export them to a JSON file.

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions&secret=123&form_id=3&filter_period=today&export_type=json

Select form #1 submissions based on a custom date range and export them to a CSV file.

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions&secret=123&form_id=1&filter_period=daterange&filter_created_from=2022-10-01&filter_created_to=2022-10-30

Select form submissions containing the keyword "apple" were received this week.

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions&secret=123&form_id=1&filter_search=apple&filter_period=this_week

Download this month's form submissions.

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions&secret=123&form_id=2&filter_period=this_month&download=1

Select today's submissions and convert their timestamps to the UTC timezone.

http://site.com?option=com_convertforms&task=cron&command=exportsubmissions&secret=123&form_id=2&filter_period=today&filter_timezone=UTC
Last updated on Oct 29th 2024 14:10