Version: v6

Webhooks Add-On Support

Gravity Forms Webhooks Add-On

Gravity Forms Webhooks add-on allows you to configure and send form data to external APIs. Gravity PDF fully integrates with the Webhooks Add-On so you can include the PDF URL(s) with your API calls.

Request Body

A key setting of the Webhooks add-on is Request Body, which is how you refine what data is sent with a request. You've the option to include all fields or select individual fields, and Gravity PDF works with both options.

All Fields

All Fields enabled

Gravity Forms will send the entire unformatted entry with the request. Any active PDFs configured on the form, which also passes the current entry conditional logic, will be added to the request body.

The key used for the individual PDFs uses the format gpdf_{ID}, where {ID} is the PDF Setting ID.

array (
...
'gpdf_6048493b8acce' => 'https://example.test/pdf/6048493b8acce/134/'
)

Select Fields

Select Fields enabled

Gravity Forms will only send the data you configure under the Field Values setting. You can include Gravity PDF URLs by selecting the Add Custom Value option in the Value select box and then adding an appropriate PDF merge tag. All merge tag modifiers are supported.

Security

There are a number of security protocols in place to prevent unauthorised access to PDF documents. Before using this feature it's highly recommended you review the documentation detailing PDF security. To allow anyone with access to the URL to view the PDF you can enable signed PDF URLs. You can only use signed PDF URLs with the Select Fields webhook method.

Last updated on