Webhooks API

Where do you want to send your File Request Pro’s data? With our Webhooks API, you can send every submission straight to any URL or compatible web application as soon as it’s submitted.

Table of Contents

Key Concepts

Webhooks are notifications that are triggered automatically when a specific event occurs and sent through the web. With the File Request Pro Webhooks API, the event is a new response submission. When a new submission comes in, a notification that contains the response data is immediately sent to your chosen destination: the URL or web application you set.

Metaphorically, webhooks are like a phone number that File Requests Pro calls to notify you each time you receive new files in your page. The webhook endpoint is the person answering that call who takes actions based upon the specific information it receives.

What Can You Do With a WebHook?

Webhooks are an incredible tool that saves you a lot of work. And the fact that they’re so popular means that you’ll be able to integrate most of the web apps you currently use. For example,

  • You can use a webhook to add a new row in an Excel or Google Sheet
  • Send your data to your CRM
  • Create a notification in Slack, SMS, Microsoft Teams.
  • Create a new entry in your project management tool like Trello, Asana, Etc.
  • You can also use Zapier to push your data to 1000s of other apps.

And much more.

How to set up a webhook URL

Step 1

Select “Page settings” from your dashboard.

File Request Pro - Your page settings

Step 2

Under the tab “Advanced Settings” You will find the webhook URL for this page. Just enter your endpoint URL in here. The end-point URL is a custom URL provided by the app or software that will receive the notification.

File Request Pro - Your page settings

We only support one webhook end-point for each page. If you need more than one, please get in touch with us.

Step 3

After saving your page, a signature key will be automatically created for you. You can use this key to validate the webhook came from File Request Pro.

File Request Pro - Your page settings

Security

File Request Pro signs the webhook post by including a frp-signature header in each event. This allows you to verify that the events were sent by File Request Pro, not by a third party.

The signature secret is found on your page settings.



File Request Pro - Your page settings

Example webhook payload

Webhooks deliver the responses to your upload forms in a JSON format. Let's walk through each object in a typical webhook payload. First, here's what a complete payload looks like when it's delivered to a webhook:

Payload Example

{
  "files": [
    "674832_DOCUMENTO_GESTION_DE_RIESGOS-1.DOCX",
    "1._Valoración_de_los_Riesgos.docx",
    "34109_FRP_Blog_Posts-2.docx"
  ],
  "form_values": {
    "field_4553": "Hello Webhooks",
    "field_4984": "[email protected]"
  },
  "field_definitions": {
    "field_4553": {
      "label": "Name",
      "type": "Text"
    },
    "field_4984": {
      "label": "Please add email",
      "type": "Email"
    }
  }
}



Files Information

Includes a list of all uploaded files names 

{
  "files": [
    "674832_DOCUMENTO_GESTION_DE_RIESGOS-1.DOCX",
    "1._Valoración_de_los_Riesgos.docx",
    "34109_FRP_Blog_Posts-2.docx"
  ]
}



Form Values

These are the values submitted by the user. Field id's change from one page to the other so your payload will be different from this one.



{
  "form_values": {
    "field_4553": "Hello Webhooks",
    "field_4984": "[email protected]"
  }
}



Field Definitions

Is an object that lists the form fields in your File Request Form. You can use the definition to match fields with answers. 

{
  "field_definitions": {
    "field_4553": {
      "label": "Name",
      "type": "Text"
    },
    "field_4984": {
      "label": "Please add email",
      "type": "Email"
    }
  }
}