Webhook as Output Destination

Utilising webhook links can be used for system integrations, whereby the generated document is sent to a webhook link. It is meant for more advanced users, or developers.

Step 1: Choose Webhook as the output destination

To receive the document as a downloadable file (Word document or PDF) via a HTTP request, select Webhook for the output destination.

Step 2: Enter the Webhook link where you want to send the document

Enter the endpoint URL that you have set up for receiving the webhook.

The webhook URL must start with http or https, and not ftp. Ensure that the webhook does not resolve to the following IP addresses, as they are not allowed:

Step 3: Customising parameters and output format

1. Specifying header and body parameters

These parameters can be configured to pass additional information with the webhook. For example you could use authorization as a header and an API key for handling authentication when doing system integrations, and could send details like form filler’s name on the body.

Apart from adding new header and body parameters in the portal, you could also view the parameters you have already added and delete them where necessary.

2. Selecting document format

The output document can be generated in .docx or .pdf format.

Errors

Here is a table of the common errors that you might face when using webhook as an output destination. See linking webhook as a data source for more errors related to webhook inputs.