Webhooks are a customizable Integration Option that will notify your systems of GoCanvas events in real time.

Webhooks

Webhooks are a powerful alternative to scraping Submission or Dispatch metadata via API endpoints like List all Submissions and List all Dispatches. When you have time-sensitive needs based on your Form events, configure a Webhook to receive near real-time notifications about the events to your back end services. Webhook payloads contain the metadata such as unique identifiers for events that you will need to perform additional API operations or kick off your own business logic.

Webhook subscriptions may be configured for the following events:

• Dispatch Creation
• Submission Creation

Webhooks are configured at a form level and will persist across all versions of a form. For example, any Webhook set up with version 2 of your form will carry forward to versions 3 and so on.

When you add Webhook configurations to your forms, a payload containing some metadata about the event will be set to the configured endpoint. As a convenience, we offer a test payload so you can be sure your integration is working before real events start triggering.

Setting up a Webhook per Form

To configure a Webhook, follow these steps: 

1. Go to the Forms page from the left navigation.
2. Select the form you want to create a Webhook for by clicking the hyperlink or the Settings gear.

3. Under Settings, scroll to about the middle of the page to Integration Options and click the Settings button.

   

4. Click the Activate button corresponding to the type of Webhook(s) you wish to configure.

   

5. A dialog box will give configuration options such as your back end server URL and allow you to send a test payload (recommended).

   

6. Once you’re satisfied with the configuration and tested, click Save and your Webhook will immediately start sending events as configured when the next event triggers.

Other Integrations

To learn about other GoCanvas integrations, please visit:

• What are Integration Options?
• Integrate an Individual Form with Box, Dropbox, and Google Drive
• Integrate with Box, Dropbox, and Google Drive at a Company Level
• Connect GoCanvas to your Favorite Tools
• What is GoCanvas Integrations?
• Getting Started with GoCanvas Integrations
• Can GoCanvas be integrated with backend systems?