Skip to content

Beautiful Open-Source Form Builder

include webhook form and submission ids (#1069)

Julien Nahuma07b032a4aa7
diff --git a/api/app/Integrations/Handlers/AbstractIntegrationHandler.php b/api/app/Integrations/Handlers/AbstractIntegrationHandler.php
index e1d330a95..62ad3f559 100644
--- a/api/app/Integrations/Handlers/AbstractIntegrationHandler.php
+++ b/api/app/Integrations/Handlers/AbstractIntegrationHandler.php
@@ -135,12 +135,16 @@ abstract class AbstractIntegrationHandler
}
$data = [
+ 'form_id' => $form->id,
'form_title' => $form->title,
'form_slug' => $form->slug,
'submission' => $oldFormatData,
'data' => $formattedData,
'message' => 'Please do not use the `submission` field. It is deprecated and will be removed in the future.'
];
+ if (isset($submissionData['submission_id'])) {
+ $data['submission_id'] = $submissionData['submission_id'];
+ }
if ($form->is_pro && $form->editable_submissions && isset($submissionData['submission_id'])) {
$data['edit_link'] = SubmissionUrlService::buildEditUrl($form, $submissionData['submission_id']);
}
diff --git a/api/tests/Feature/Forms/FormIntegrationTest.php b/api/tests/Feature/Forms/FormIntegrationTest.php
index 5a5c9d73c..e667bcf67 100644
--- a/api/tests/Feature/Forms/FormIntegrationTest.php
+++ b/api/tests/Feature/Forms/FormIntegrationTest.php
@@ -1,5 +1,7 @@
<?php
+use Illuminate\Support\Facades\Http;
+
it('can CRUD form integration', function () {
$user = $this->actingAsProUser();
$workspace = $this->createUserWorkspace($user);
@@ -205,6 +207,57 @@ it('can create form integration with checkbox logic', function () {
});
describe('Webhook Integration', function () {
+ it('includes form and submission ids in the webhook payload', function () {
+ Http::fake([
+ 'https://example.com/*' => Http::response(['ok' => true], 200),
+ ]);
+
+ $user = $this->actingAsProUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace, [
+ 'properties' => [
+ [
+ 'id' => 'name',
+ 'name' => 'Name',
+ 'type' => 'text',
+ 'hidden' => false,
+ 'required' => true,
+ ],
+ ],
+ ]);
+
+ $this->postJson(route('open.forms.integrations.create', $form), [
+ 'status' => 'active',
+ 'integration_id' => 'webhook',
+ 'logic' => null,
+ 'data' => [
+ 'webhook_url' => 'https://example.com/webhook',
+ 'webhook_secret' => 'whsec_1234567890abcdefghijklmnop',
+ ],
+ ])->assertSuccessful();
+
+ $submissionData = $this->generateFormSubmissionData($form);
+
+ $this->postJson(route('forms.answer', $form->slug), $submissionData)
+ ->assertSuccessful();
+
+ Http::assertSent(function ($request) use ($form, $submissionData) {
+ $payload = json_decode($request->body(), true);
+ $expectedSignature = 'sha256=' . hash_hmac(
+ 'sha256',
+ $request->body(),
+ 'whsec_1234567890abcdefghijklmnop'
+ );
+
+ return $request->url() === 'https://example.com/webhook'
+ && $payload['form_id'] === $form->id
+ && is_int($payload['submission_id'])
+ && $payload['submission']['Name'] === $submissionData['name']
+ && $payload['data']['name']['value'] === $submissionData['name']
+ && $request->hasHeader('X-Webhook-Signature', $expectedSignature);
+ });
+ });
+
it('can create webhook with secret and custom headers', function () {
$user = $this->actingAsProUser();
$workspace = $this->createUserWorkspace($user);
diff --git a/docs/api-reference/integrations/create-webhook-integration.mdx b/docs/api-reference/integrations/create-webhook-integration.mdx
index 9bd412666..c1d1c1efd 100644
--- a/docs/api-reference/integrations/create-webhook-integration.mdx
+++ b/docs/api-reference/integrations/create-webhook-integration.mdx
@@ -135,6 +135,7 @@ Each webhook request will include:
- **`X-Webhook-Signature` header**: Contains the signature in format `sha256=HEXADECIMAL_VALUE`
- **Custom headers**: Any headers you specified in `webhook_headers` (except blocked headers)
+- **JSON body metadata**: The payload includes `form_id` and `submission_id` so you can correlate webhook deliveries with OpnForm API submission management endpoints
### Blocked Headers
diff --git a/docs/api-reference/integrations/webhook-security.mdx b/docs/api-reference/integrations/webhook-security.mdx
index c858edc78..75261d12d 100644
--- a/docs/api-reference/integrations/webhook-security.mdx
+++ b/docs/api-reference/integrations/webhook-security.mdx
@@ -189,7 +189,9 @@ Authorization: Bearer my-api-token
X-Custom-Header: custom-value
{
+ "form_id": 123,
"form_title": "Contact Form",
+ "submission_id": 456,
"submission": { ... }
}
```