Configure An API Webhook Connection

In this guide, we will explain how to configure an API Webhook Connection for your Formyoula form. And how to set up the webhook endpoint, map form fields to the request body, and prepare the connection to send form submission data to your external API.

1. Create an API Webhook Connection:

  • Open the Formyoula Dashboard.
  • Navigate to the Connections page for your form using either of the following options:
    • Click “Create a Connection”, or
    • Click “Actions” → “Add/Edit Connections”.
image
  • Select “API Webhook” from the list of available connections.
  • Click “Create Connection”.
image

2. Configure The API Webhook Connection:

  • Set up the connection.
    • Description – Enter a name or description to identify the connection.
    • HTTPS Endpoint URL – Enter the HTTPS endpoint that will receive the webhook request.
    • HTTP Method – Select the required request method, for example POST.
    • Timeout – Select how long Formyoula should wait for a response from the endpoint.
      • image
    • Request Headers: Request Headers can be used to send additional information required by the receiving API, such as authentication tokens, API keys, source identifiers, or other custom header values.
    • Note: The required header names and values depend on the external API you are connecting to. These details should be provided by the API owner.
      • image
    • Request Body Mapping: This section allows you to choose which Formyoula fields should be included in the webhook request. For each field:
      • Enter the required “API Body Key”.
      • Select the corresponding “Formyoula Field”.
      • Click the + button to add another mapping.
      image
    • Successful HTTP Status Codes: Define which response codes should be treated as successful.
    • Sequence: Define the order in which the connection should run when multiple connections are configured.
    • Run On Existing Entry Update: This option controls whether this Connection should run again when an existing Formyoula entry is edited.
    • Disable This Connection: This option can be used to temporarily stop this webhook from running without deleting its configuration.
      • image
    • Save the changes by clicking the “Save API Connection”.
image

3. Test The Connection:

  • Try the form.
  • Enter the details.
  • Submit the form.
image
  • The connection will send the data to the webhook.
image
Example Form.json4.1 KiB

For any questions, please contact us - [email protected] or the Formyoula in-app chat 🙂