Template Settings

You can click the "Settings" button in the header to configure your template settings.

Configure default values for field options in the sidebar on the right.

Expire Submissions

The Expire Submissions setting allow you to configure a data retention policy for your template.

You can configure the period of time until FormAPI deletes generated PDFs, submission data, and any images. (Please note that electronic signatures are retained for UETA and ESIGN compliance.) When "Expire Submissions" is unchecked, your PDFs and submission data will never be automatically deleted.

You can also make an API request to immediately expire a submission.

Bitcoin Blockchain Verification

When the Bitcoin Blockchain Verification setting is enabled, every generated PDF will have a timestamp proof recorded in the Bitcoin blockchain. This cryptographically verifies the integrity and existence of your PDF at the time of verification. Blockchain verification data is available when you view a submission, and you can click a link to view the Bitcoin transaction.

Read more about the technical details.

Allow Additional Properties

By default, the data that you submit must exactly match the JSON schema. Any additional properties will cause a validation error. This guarantees that you haven't forgotten to add any fields to your template, and it also guards against accidental field deletion.

When the Allow Additional Properties in JSON Data setting is enabled, additional properties in your data will be silently ignored. This can be useful when you you don't have full control over the JSON data (e.g. a webhook integration with a third-party service.)

Online Form Privacy

Set this to Public to allow anyone to fill out the online form if they have the URL.

Submission Privacy

Set this to Public to allow anyone to view submission data and download their PDF if they have the URL.

This is useful when you have added a @@data_url QR code to the PDF. (@@data_url is a URL where the submission data can be viewed or downloaded.)

Webhook URL

If you configure a Webhook URL, we'll send a POST request whenever a PDF is processed. We also send webhooks when a submission contains invalid data, or if there is a error while processing the submission.

Webhooks are sent for both live and test PDFs. Make sure you ignore test PDFs in production —
data['submission']['test'] will be true for test PDFs.

Note: You can also set a "Default Webhook URL" for every API token, which will be used when the template webhook URL is blank. When you set the webhook URL for an API token, a webhook request will be sent for every PDF that is generated using that API token.

Webhook requests will include the following data:

{
  "submission": {
    "id": "fkgYdAdaYJPPTp99",
    "state": "processed",
    "test": false,
    "expired": false,
    "expires_at": "2017-10-13T20:51:55.032Z",
    "data": {},
    "metadata": {},
    "source": "api",
    "download_url": "https://..."
  }
}

The state attribute will be one of the following:

  • pending: The PDF is being generated.
  • processed: The PDF is ready to download.
  • invalid_data: Your API request contained invalid data.
  • error: We experienced an internal server error, and will retry the job.
  • image_download_failed: We could not download an image from the URL you provided.
  • image_processing_failed: We experienced an error when trying to resize your image.

Your webhook handler must return a 200 status code, otherwise we will assume that the request has failed. If the webhook fails, we will retry it 25 times over approximately 21 days.

Note: When receiving a webhook, we recommend making an API request to fetch the submission by ID. This protects against spoofed webhook requests.

Slack Webhook URL

Configure an Incoming WebHook in Slack, and paste the URL into this field. We'll send a message whenever a PDF is generated:

Slack Message

Redirect URL

We'll redirect users to this URL whenever they fill out the online form to generate a PDF. This applies to online forms hosted on formapi.io, and embedded forms on your own website. The submission ID, template ID, and template name will be appended to the URL as query params.

results matching ""

    No results matching ""