1. Working with Forms dashboards

Work with the webhooks dashboard

Webhooks are used to capture submitted inputs to your database. They can be used to trigger business workflows you might have set upon form submission.

The Webhooks dashboard displays a table listing all the webhooks created for your forms, their authentication type, and if they're being used. The dashboard offers options for creating webhooks, as well as for managing them. The table can be searched or sorted by applying filters.

A Webhooks dashboard

Create a webhook

You can create a webhook for a specific form in the form editor, as well as in the Webhook dashboard.

To create a webhook:

  1. On the Webhook dashboard, click Create webhook.

  2. In the Create Webhook dialog, select one of the following types of authentication, and then enter the required information:

    • OAuth2 (client credentials flow) - every request towards the targeted Webhook URL requires a valid JSON Web Token, which is provided by the Identity provider that the author of the Form represents. After successful retrieval, the JSON Web Token (JWT) can be cached and reused until it expires. On expiration, a new token is created by re-authenticating to the defined provider.

      To set up an OAuth 2 authentication, you must provide the following information:

      • Client ID

      • Client secret

      • Authorization end point URL

    • Basic authentication - authenticate the caller on each request by providing the defined credentials as the Authorization Header into the request. To set up a basic authentication, enter the following information: 

      • Username

      • Password

    • API Key - a static predefined string content needs to be added on each request during the push of input data of the end user. To set up an API key authentication, enter the following information:

      • Header name

      • API key value

    • No Authentication – the application does not need any authentication in order to send the end user’s input data.

      Warning

      We strongly discourage using this option.

  3. Also enter the following information:

    • Name - enter the name of the webhook.

    • URL - the destination of the transferred data.

  4. Click Save.

You can now manage your webhooks, or create custom events for each webhook.

Manage your webhooks

To manage your webhooks from the dashboard:

  • On the Webhooks page, click Actions and then click one of the options:

    • Edit a webhook - to edit the authentication type, name, and URL.

    • Delete a webhook - to delete webhooks where In use is set to No.

See also Work with webhooks for information on how to manage webhooks for an individual form.

If you have suggestions for improving this article, let us know!