Skip to content
Help

All help pages

Webhooks

Send each submission to your CRM, Zapier, Make or your own server.

From the Starter plan, a webhook sends each new submission in real time to the address of your choice: a CRM, an automation tool (Zapier, Make, n8n) or your own application.

Add a webhook

  1. In the editor, open the Integrations tab, Webhooks card.
  2. Paste the address (starting with https://) provided by your tool.
  3. Keep the Signing secret shown. It lets you check that deliveries come from Canard Form.

Each webhook's log shows the latest deliveries, their result and the response code from your tool.

A form can have 1 webhook on the Starter plan and up to 3 on the Pro plan. If you move to a plan that allows fewer, nothing is deleted: only the oldest ones, within the plan's limit, keep receiving submissions.

Payload

Each submission is sent in a JSON POST request. It contains the event identifier, its type (submission.created), the form, the version and the answers. Files are provided as a temporary download link.

POST /your-endpoint HTTP/1.1
Content-Type: application/json
User-Agent: CanardForm-Webhook/1.0
Canard-Event: submission.created
Canard-Delivery: 01a1c9f2-7b3e-7d10-9a4c-5e2f8b6d1c03
Canard-Signature: t=1795003512,v1=5f1c0e9a…
{
    "id": "01a1c9f2-6e8a-7f42-b1d5-0c3a9e7f2b18",
    "type": "submission.created",
    "created_at": "2026-11-18T09:25:12+00:00",
    "data": {
        "submission": {
            "id": "01a1c9f2-6d31-7c55-8e0b-4f9a2d6c3e71",
            "form_id": "01a1c446-57f6-70ea-9d46-09d5096e3fc9",
            "form_version": 3,
            "created_at": "2026-11-18T09:25:11+00:00",
            "locale": "en",
            "answers": {
                "name": "Camille Martin",
                "email": "camille@example.com",
                "topic": "quote",
                "options": ["delivery", "assembly"],
                "budget": 1500,
                "consent": true,
                "source": "newsletter"
            },
            "files": [
                {
                    "field": "plan",
                    "name": "kitchen-plan.pdf",
                    "size": 482113,
                    "mime": "application/pdf",
                    "sha256": "9f2b5c…",
                    "status": "clean",
                    "url": "https://canardform.app/v1/attachments/01a1c9f2-…?expires=1795004412&signature=…"
                }
            ]
        }
    }
}
  • id identifies the event: it stays the same when a delivery is retried. Keep it so you never process the same answer twice.
  • answers uses the field keys (shown in the editor's Advanced settings). A field left empty is not included. A dropdown or single choice gives the option's value, a multiple choice a list of values, a number a number, a checkbox true or false.
  • files describes the uploaded files. The url link is valid for 15 minutes: download the file as soon as you receive it. It is null while the file is not clean (status: infected or scan_failed). When the antivirus is on, the delivery waits for the scan to finish, 15 minutes at most.

Verify the signature

Each delivery includes a Canard-Signature: t=<timestamp>,v1=<signature> header. The signature is an HMAC-SHA256 of <timestamp>.<request body>, computed with your signing secret.

  1. Compute the signature and compare it with the one in the header.
  2. Reject the request if the timestamp is too old (more than 5 minutes, for example).

Example in Node.js:

{
    "id": "01a1c9f2-6e8a-7f42-b1d5-0c3a9e7f2b18",
    "type": "submission.created",
    "created_at": "2026-11-18T09:25:12+00:00",
    "data": {
        "submission": {
            "id": "01a1c9f2-6d31-7c55-8e0b-4f9a2d6c3e71",
            "form_id": "01a1c446-57f6-70ea-9d46-09d5096e3fc9",
            "form_version": 3,
            "created_at": "2026-11-18T09:25:11+00:00",
            "locale": "fr",
            "answers": {
                "nom": "Camille Martin",
                "email": "camille@exemple.fr",
                "sujet": "devis",
                "options": ["livraison", "montage"],
                "budget": 1500,
                "accord": true,
                "source": "newsletter"
            },
            "files": [
                {
                    "field": "plan",
                    "name": "plan-cuisine.pdf",
                    "size": 482113,
                    "mime": "application/pdf",
                    "sha256": "9f2b5c…",
                    "status": "clean",
                    "url": "https://canardform.app/v1/attachments/01a1c9f2-…?expires=1795004412&signature=…"
                }
            ]
        }
    }
}
  • id identifie l'événement : il reste le même si l'envoi est retenté. Gardez-le pour ne pas traiter deux fois la même réponse.
  • answers utilise les clés des champs (visibles dans les Réglages avancés de l'éditeur). Un champ laissé vide n'y figure pas. Une liste ou un choix unique donne la valeur de l'option, un choix multiple une liste de valeurs, un nombre un nombre, une case à cocher true ou false.
  • files décrit les fichiers envoyés. Le lien url est valable 15 minutes : téléchargez le fichier dès la réception. Il vaut null tant que le fichier n'est pas sain (status : infected ou scan_failed). Quand l'antivirus est actif, l'envoi attend la fin de l'analyse, 15 minutes au plus.

Vérifier la signature

Chaque envoi contient un en-tête Canard-Signature: t=<horodatage>,v1=<signature>. La signature est un HMAC-SHA256 de <horodatage>.<corps de la requête>, calculé avec votre clé de signature.

  1. Recalculez la signature et comparez-la à celle de l'en-tête.
  2. Refusez la requête si l'horodatage est trop ancien (plus de 5 minutes, par exemple).

Exemple en Node.js :

import crypto from 'node:crypto';

function verify(rawBody, header, secret) {
    const { t, v1 } = Object.fromEntries(
        header.split(',').map((part) => part.split('=')),
    );
    const expected = crypto
        .createHmac('sha256', secret)
        .update(`${t}.${rawBody}`)
        .digest('hex');
    const fresh = Math.abs(Date.now() / 1000 - Number(t)) < 300;

    return (
        fresh &&
        v1.length === expected.length &&
        crypto.timingSafeEqual(Buffer.from(v1), Buffer.from(expected))
    );
}

Compute the signature on the raw request body, before any JSON decoding.

Failures and retries

If your tool doesn't respond or returns an error, Canard Form retries the request several times, at increasing intervals. After 48 hours of consecutive failures, the webhook is turned off. Once your tool is fixed, you can turn it back on in one click. Delivery history is kept for 30 days.

For security reasons, only public HTTPS addresses are accepted.