[Paperform Integration] How to set up your webhook triggers

In the form editor, navigate to After Submission in the top bar → Choose Integrations & Webhooks.

Click the "Webhooks" section near the bottom of the page to open the configuration options.

Click the "Add Webhook" button.

Enter your webhook URL in the field provided.

Within the "Triggered On" dropdown menu, select the event to be triggered response to a New Submission, or a Partial Submission

Click the "Create" button to finalize your changes.

Paperform currently do not support any customizations of headers. If, for example, you require authorization for your endpoint, you'll need to include it in the webhook URL's query string.

Answer Piping

If you need to pass the answer to the external systems as query params, it is doable.

You can add answer piped values by either typing {{key}} ("key" as the relevant question's pre-fill key) or by using the + menu to the right of the input.

Sample JSON payload

{  
  "data": [  
    {  
      "title": "question 1", // Title of question as defined  
      "description": "This is the first question",   
      "type": "address", // Question type  
      "key": "ba7ri", // Question pre-fill key (unique to form)  
      "custom_key": "address_1", // Custom pre-fill key (if set) 
      "value": "343 Tester Road, Snohomish, Washington, 98290, United States" // Submitted value for question
    },  
    {  
      "title": "question 2",  
      "description": "This is the second question",  
      "type": "text",  
      "key": "tgp8",  
      "custom_key": null,  
      "value": "Test 123"  
    }  
    // ...each question has its own object.  
  ],  
  "submission_id": "XXXXXXXXXXXXXXXXXXX", // Unique ID for submission.  
  "created_at": "2017-06-09 09:51:23", // Submission date  
  "ip_address": "192.168.10.1", // IP Address of submission  
  "charge": null // If a payment is made, payment information is given here  
}        

Testing the webhook

You can test a webhook at any time by clicking the "Test" button in the "Webhooks" section. Doing so will trigger the webhook using the most recent form submission's data. Alternatively, you may test your webhook by submitting the form itself.

Please note that the "Test" button will only function if the form has been submitted at least once previously.

Reference:

https://paperform.co/help/articles/how-to-use-webhooks/