How to integrate webhooks to your form
To integrate a webhook that sends data when someone submits a form, click on Integrate, then Webhooks.
Clicking on Add Webhook will open the screen for you to configure your new webhook.
Yay! Forms also offers security features to enhance the integrity and reliability of webhook integrations. These include:
Payload Signature Secret: You can now specify a "Secret" that will be used to sign the webhook payload with HMAC SHA256. This allows you to verify that the payload indeed came from Yay! Forms, ensuring the authenticity of the received data.
SSL Verification: We have added the option to verify SSL for payload deliveries. When the Verify SSL option is checked, Yay! Forms will validate SSL certificates when delivering payloads, providing an additional layer of security in communication.
Custom Header: For greater flexibility, you can now add a Custom Header to the webhook payload. Simply specify the desired custom header, and it will be included in the sent payload.
These features enhance the user experience and ensure the security of webhooks in Yay! Forms. To use these options, access the webhook editing screen:
After configuring your webhook, you can easily enable or disable it by clicking the button below. Additionally, you can adjust the settings or test it by clicking on the three dots and selecting Test.
This advanced option allows users to choose whether they want to trigger webhooks for past form submissions. To do this, simply enable the Run on Previous Responses option, as shown in the image below:
This feature allows webhooks to be triggered based on user responses, ensuring smarter and more effective integrations. To set this up, scroll down to the Trigger Condition section, as shown in the image below:
If you are interested in understanding better how our conditional system works, you can access our help file on How to Create Expressions for Conditional Execution of Integrations.
It is important to note that, by default, the conditional field is case-sensitive. That is, if the user answers yes, and you have set Yes, it will not send the form data. If you want to remove this distinction between uppercase and lowercase letters, you can enable the Case-Insensitive Trigger Condition option, which is located below the trigger condition.
Yay! Forms offers two webhook formats ( V1 and V2), each with different structures to meet specific needs. See the differences:
Response Format:
Responses are sent in an array of objects, where each object represents an individual response.
Simplified example:
Response Format:
Responses are organized in an object with unique keys (response IDs).
Simplified example:
Included Details:
With V2, you can use the field ID as the key for field identification, which helps in mapping the fields.
Fill Out the Form
To ensure the test is sent correctly, the form must have at least one valid response filled out.
Data Sending
The test will send data from the last valid response submitted.
Sending Status
Please note that the test does not mark the response as sent in the respective integration being tested. This is only a procedure to verify the integration.
We hope you enjoy the new integration
If you have any questions or suggestions, send an email to help@yayforms.com
Clicking on Add Webhook will open the screen for you to configure your new webhook.
Yay! Forms also offers security features to enhance the integrity and reliability of webhook integrations. These include:
Payload Signature Secret: You can now specify a "Secret" that will be used to sign the webhook payload with HMAC SHA256. This allows you to verify that the payload indeed came from Yay! Forms, ensuring the authenticity of the received data.
SSL Verification: We have added the option to verify SSL for payload deliveries. When the Verify SSL option is checked, Yay! Forms will validate SSL certificates when delivering payloads, providing an additional layer of security in communication.
Custom Header: For greater flexibility, you can now add a Custom Header to the webhook payload. Simply specify the desired custom header, and it will be included in the sent payload.
These features enhance the user experience and ensure the security of webhooks in Yay! Forms. To use these options, access the webhook editing screen:
After configuring your webhook, you can easily enable or disable it by clicking the button below. Additionally, you can adjust the settings or test it by clicking on the three dots and selecting Test.
Advanced Features
1. Optional Execution of Past Webhooks
This advanced option allows users to choose whether they want to trigger webhooks for past form submissions. To do this, simply enable the Run on Previous Responses option, as shown in the image below:
2. Conditional Triggering Based on Responses
This feature allows webhooks to be triggered based on user responses, ensuring smarter and more effective integrations. To set this up, scroll down to the Trigger Condition section, as shown in the image below:
If you are interested in understanding better how our conditional system works, you can access our help file on How to Create Expressions for Conditional Execution of Integrations.
It is important to note that, by default, the conditional field is case-sensitive. That is, if the user answers yes, and you have set Yes, it will not send the form data. If you want to remove this distinction between uppercase and lowercase letters, you can enable the Case-Insensitive Trigger Condition option, which is located below the trigger condition.
Understanding Webhook Versions (V1 and V2)
Yay! Forms offers two webhook formats ( V1 and V2), each with different structures to meet specific needs. See the differences:
Webhook V1
Response Format:
Responses are sent in an array of objects, where each object represents an individual response.
Simplified example:
"answers": [
{ "id": "65d4e7414e5adf68470edb9e", "content": "..." },
{ "id": "6273f707c63e7adf3c0203e3", "content": "..." }
]Webhook V2
Response Format:
Responses are organized in an object with unique keys (response IDs).
Simplified example:
"answers": {
"65d4e7414e5adf68470edb9e": { "content": "..." },
"6273f707c63e7adf3c0203e3": { "content": "..." }
}Included Details:
With V2, you can use the field ID as the key for field identification, which helps in mapping the fields.
Important Notes
Fill Out the Form
To ensure the test is sent correctly, the form must have at least one valid response filled out.
Data Sending
The test will send data from the last valid response submitted.
Sending Status
Please note that the test does not mark the response as sent in the respective integration being tested. This is only a procedure to verify the integration.
We hope you enjoy the new integration
If you have any questions or suggestions, send an email to help@yayforms.com
Updated on: 21/02/2025
Thank you!