Webhooks API

Configure destinations for submission data. Webhook management uses API authentication; your receiving server accepts outbound POST requests.

All requests require X-EMAIL and X-API-KEY. See authentication and errors. JSON request bodies also require Content-Type: application/json. All IDs in examples are synthetic; replace them with your own values.

Endpoints

Create a webhook as the form creator using an Owner or Admin account. Then update it to configure signing or pause delivery. Update and delete require the same user that owns the webhook.

Delivery payload

The standard destination receives a JSON array, with one entry per question/answer produced by the submission aggregation. It is not wrapped in the API’s Errors/Data envelope. The _id is the numeric form ID; properties and response vary by question type. An abbreviated text-answer example:

[
  {
    "_id": 12345,
    "surveyName": "Customer feedback",
    "type": "Text Question",
    "title": "How can we improve?",
    "description": "",
    "properties": {},
    "response": "More appointment slots"
  }
]

Form submissions remain available through the Responses API and builder reports. Delivery uses a 10-second request timeout. Return a 2xx status quickly and process work asynchronously. Inspect delivery history in the form’s webhook integration to diagnose failures or redeliver. Redelivery replays the stored JSON body without double encoding. The current sender does not implement the previously documented 300-failure/24-hour automatic disabling rule or scheduled automatic retries; do not rely on either.

Verify signatures

Set webhookSecret through Update a webhook to enable signing. The receiver gets a RapidoReach-Signature header containing the Base64 HMAC-SHA256 of the exact raw request body. There is no sha256= prefix. Whitespace matters: verify the raw bytes before parsing JSON.

Example for an Express receiver using Node’s built-in crypto module. Configure RAPIDOFORM_WEBHOOK_SECRET privately on the receiving server:

const express = require('express');
const { createHmac, timingSafeEqual } = require('node:crypto');
const app = express();
const secret = process.env.RAPIDOFORM_WEBHOOK_SECRET;
if (!secret) throw new Error('Webhook signing secret is required');

// Register before any global express.json() middleware.
app.post('/hooks/rapidoform', express.raw({ type: 'application/json' }), (req, res) => {
  const provided = req.get('RapidoReach-Signature') || '';
  const expected = createHmac('sha256', secret).update(req.body).digest('base64');
  const a = Buffer.from(provided);
  const b = Buffer.from(expected);
  if (a.length !== b.length || !timingSafeEqual(a, b)) {
    return res.sendStatus(401);
  }
  // Validate and enqueue the payload in durable storage before acknowledging.
  const payload = JSON.parse(req.body.toString('utf8'));
  return res.sendStatus(204);
});
app.listen(4000);

Signing is disabled when webhookSecret is empty. HTTPS protects transport; HMAC verifies the body. The signature has no timestamp/replay protection, so design your receiver to tolerate duplicate deliveries and redelivery.

TLS and delivery settings

Use a complete HTTPS URL. verifySSL defaults to true for new webhooks and controls certificate verification on the HTTPS agent for live, test and redelivery requests. Keep it enabled. Existing webhooks retain their saved value. Destinations must use public HTTP/HTTPS URLs without embedded credentials. Redirects are not followed; configure the final destination URL. The outgoing User-Agent is RapidoReach Webhooks. There is a special payload wrapper for the platform’s Teams destination; the array example above describes standard webhook URLs.