Webhooks are real-time messages that are sent to your URL that get triggered in response to a specific event. To create a Webhook you just need to configure a URL and start ‘listening’ to events. Follow these steps and test it out!
No MoreApp account yet? Sign up here.
This feature is available in the Branch, Tree and Forest plan. Visit our Pricing page.
1. What is a Webhook?
Webhooks are real-time messages that are sent to your URL that get triggered in response to a specific event. When a trigger occurs, a Webhook sends a payload to the predefined URL (Webhook endpoint) which can trigger a specific action on its turn. This allows you to connect MoreApp with any other software.
2. Difference between API and Webhooks
API and Webhooks are both methods to create communication between software.
Webhooks are real-time, based on events on our server. APIs, however, retrieve data from our server on demand via an API call.
A combination of these two can be very useful. For example, use a Webhook to trigger a process and fetch documents from our server with an API call.
If you want more information regarding the configuration of Webhooks and API, check out our Developer Docs.
3. When to use a Webhook
We recommend using Webhooks when you want:
To notify your system about specific events within MoreApp. This can be events such as receiving new submissions, integration pipeline events and fulfilled instructions.
To integrate with other software and automate your processes.
To update a database, based on a trigger from MoreApp. This way you can keep your data synchronised.
4. Configure your Webhook
When you have permission (add link) to create Webhooks you can go to the Settings tab and access Webhooks. Click on Add in order to create a new Webhook.
Note: You can create a maximum of 100 Webhooks per account.
Give the Webhook a name and add the URL of the endpoint to which you want MoreApp to send the data.
You need to provide this URL via another software, like Zapier, Integromate or any other automation tool.
Note: If you have multiple Webhooks, there is the possibility to trigger them from the same event in your account. You can combine URLs into a single URL. Read how to trigger multiple Zaps with Webhooks.
After providing the correct URL, you will need to select the event type that you want MoreApp to use as a trigger. For example, choose ‘submission.created’ to show that the Webhook needs to be triggered whenever a submission is created.
These are the currently available event types and their explanations:
|submission.created||An end-user has submitted a form|
|sumbission.pipeline.created||Started processing the submission|
|submission.pipeline.blocked||Submission processing has failed due to an error; it will not be retried automatically|
|submission.pipeline.failed||Submission processing has failed due to an error; it will be retried automatically|
|submission.pipeline.succeeded||Submission processing has succeeded|
|submission.pipeline.mail.sent||Submission processing caused a mail to be sent out|
|submission.instruction.created||An instruction has been created|
|submission.instruction.fulfilled||An end-user has failed an instruction|
Export has been scheduled
Export has been started
Export has finished (either successfully or failed)
Once you finish, click on Save.
Every API that is not documented in our API documentation can be changed at any moment.
Take into account that the date format you receive via Webhooks is YYYY-MM-DD.
The URL should accept an HTTP POST request with a JSON body and return an HTTP 200 OK status code.
Make sure that at least 1 in 50 requests come back successfully. MoreApp automatically disables a Webhook when 50 consecutive failures have occurred.
Webhooks can not send data from events that happened in the past.
Do you want to be the first one to see our latest tutorials? Go to YouTube and hit the Subscribe button!