How To Use Webhooks

Webhooks are used by developers to integrate Paperform form submissions into their own services. This is particularly useful if you would like to use forms within your own services or do something special or difficult with the submitted data. Note that webhooks are only available on Pro and Agency plans. For non-technical teams, Zapier is a more appropriate solution for most needs.

Adding a webhook

On the edit page of your form, go to Configure > Integrations. Under the “Add Webhook” section, add the URL of your endpoint and click the “ADD” button to add the webhook. That’s all it takes.

Testing webhooks

You can test a webhook at any time, by clicking the “TEST” button in the “Webhooks” section of Configure > Integrations. This will trigger the webhook with the latest submission’s data.

Note that the form must have at least one submission to test webhooks.

Submission payload

Webhooks POST a JSON payload on submission to the webhook URL. The JSON payload looks like the following;

{
    "data": [
        {
            "title": "question 1", //Title of question as defined
            "description": "This is the second question", 
            "type": "address", //Question type
            "key": "ba7ri", //Question pre-fill key (unique to form).
            "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",
            "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.
}

The easiest way to see what your submission structure looks like is to use a service like https://requestb.in to create a webhook URL and send test data there.

webhooks, integrations