Webhooks

Outerform can send form data to any URL that supports POST, with a JSON request body corresponding to the blocks on the form.

The Webhook will be called for every response to your form.

Creating a Webhook

To create a Webhook integration for a form, open the form and navigate to the Integrations tab in the header bar.

Next, click Set up on the Webhook integration. This will open a window where blocks from the form can be mapped to the request body that will be sent to the webhook url:

New Webhook

Mapping Blocks

Outerform needs to know what fields to set in the JSON request object for each block on the form. To do this, go through each block and set the field name that will be used as the key/value pair for the value for this block when the response is submitted.

For example, in the above example we have a question on the form labeled 'Can we have your email?' so we map that to the email field in the JSON request body.

To map blocks to nested fields, use dot syntax. For example, user.email will map the value to

{
  "user": {
    "email": value
  }
}

Headers

To specify additional headers, expand the Headers option and provide header name/value mappings:

Webhook Headers

Additional fields

To manually add any additional fields to the request body that will always be provided, expand the Additional Fields section:

Additional Fields