Using our API [EN]

You can use the Docfield REST API to integrate Docfield with other applications, to automate tasks, and much more.

The API provided by Docfield offers functionality such as creating documents, sending them out for signing, and generating PDFs. For a complete and up-to-date overview of all the possibilities of our API, please refer to our API documentation.

Requesting an API Key

To request an API Key for using the API, you can follow these steps:

1. Make sure you are an Administrator within Docfield, or ask the Administrator to perform the steps.

2. Go to Settings > API Settings.

3. Choose Add New API Key and select a name for your key—for example, the name of the application you want to integrate with.

4. Copy your Client and Secret. Save these securely; they cannot be recovered if lost.

Once you have a key, you can use it to call one of the API endpoints described in our API documentation. Use OAuth 2.0 to authenticate with the API.

Setting Up a Webhook

To retrieve PDFs of documents, we provide an endpoint to request PDFs, in combination with a Webhook. We will call this Webhook at an endpoint that you host; Docfield will submit a POST request when a new PDF is generated.

Here’s how to set up a Webhook:

1. Make sure you are an Administrator within Docfield, or ask the Administrator to perform the steps.

2. Go to Settings > API Settings, select the API application for which you want to set up the Webhook, and choose Configure Webhook from the menu (...).

3. Enter the URL of your Webhook. We expect an HTTPS URL. For example, if you enter https://domain.com/api/docfield/pdf, then Docfield will send a POST request to https://domain.com/api/docfield/pdf whenever a new PDF becomes available.

Good to know:
We will always send a request to all webhooks in your environment for every PDF generated. It doesn't matter whether the PDF is generated by the user within the application or requested by another API application—all webhooks in your environment will receive a notification. Make sure your application filters which requests to keep and which to discard.