Formstep

Ondertekende JSON naar je eigen endpoint

Als de bestemming je eigen backend is, een serverless functie of een tool zonder eigen integratie, dan is een webhook de integratie. Elke inzending komt binnen als één JSON-event, per veldsleutel, ondertekend zodat je kunt bewijzen dat het van Formstep komt, en opnieuw geprobeerd tot je endpoint ja zegt.

Bijgewerkt

Zo werkt het

  1. Open de Integraties van het formulier, kies Webhook en typ de URL. Laat de koppeling leeg om elk veld te sturen, of voeg rijen toe om alleen sommige te sturen, onder de JSON-sleutels die je kiest. Voorbeeldaanvraag bekijken toont hoe de body verandert terwijl je bewerkt.
  2. Kopieer het ondertekeningsgeheim, dat begint met whsec_ en één keer wordt getoond. Voeg tot vijf eigen headers toe, zoals een autorisatietoken.
  3. Klik op Webhook aanzetten en dan op Testevent versturen: een ondertekende POST met voorbeeldantwoorden en je headers, vastgelegd in het eventlogboek zoals een echte bezorging.

Bekijk de volledige gids

Wat er binnenkomt

Eén envelop voor alles wat Formstep verstuurt: id, type, createdAt, apiVersion, test en data. Onder data: het formulier, de inzending met haar id, het e-mailadres van de respondent, tijd, taal en PDF-link, een answers-object voor code, per veldsleutel, en een display-object met dezelfde sleutels als leesbare tekst. Een keuzeantwoord is zijn optiesleutel in answers en zijn label in display; een bestand is een lijst met downloadlinks in het ene en bestandsnamen in het andere. Een inzending die een aanvraag beantwoordde, voegt een request-blok toe met je externe id en metadata.

X-Formstep-Signature: t=TIMESTAMP,sha256=HEX

Een formulier kan meerdere webhooks hebben; elke gaat af voor elke inzending en elke latere wijziging, te onderscheiden aan type. Zet De veldenlijst bij elk event meesturen aan als je ontvanger fields.list niet zelf kan aanroepen.

Nieuwe pogingen

Elke 2xx is een succes. Formstep probeert het tot vijf keer: meteen, daarna na minstens 1, 2, 4 en 8 minuten, zodat de laatste poging ongeveer twee uur na de eerste komt. 429, 5xx, time-outs en verbindingsfouten worden opnieuw geprobeerd, en een langere Retry-After wordt gerespecteerd. 401, 403 en 404 stoppen de integratie meteen en sturen een e-mail naar degene die hem heeft ingesteld. Bezorgingen die alle vijf pogingen hebben gebruikt, verschijnen in een banner op de integratie; Alles opnieuw proberen verstuurt ze opnieuw en zet een gepauzeerde integratie weer aan.

Stel voor lokale ontwikkeling je dev-server beschikbaar met ngrok of een Cloudflare-tunnel en richt de webhook daarop. Maak voor onafgemaakte antwoorden via een openbare link een submission_abandoned-abonnement aan met de REST API; de webhook die je hier toevoegt, gaat daarvoor nooit af.

Een workflowtool met een webhooktrigger, zoals Make of Pipedream, kan deze ook ontvangen. Is de ontvanger een workflow die op één specifieke persoon wacht, dan wil je de callback van een aanvraag in plaats van een webhook: die gaat eenmaal af, voor die aanvraag, met de uitkomst.

Vragen over Formstep voor Webhooks

Nog iets anders? De documentatie behandelt elke instelling, en we beantwoorden e-mail.

Lees de documentatie

Een webhook hoort bij het formulier en gaat af voor elke inzending, van deellinks en aanvragen. Een callback hoort bij één aanvraag: de URL die je als callbackUrl meegeeft bij het aanmaken, die eenmaal wordt aangeroepen als die aanvraag eindigt. Beide hebben dezelfde event-envelop.

Elke aanvraag heeft een X-Formstep-Signature-header van de vorm t=TIMESTAMP,sha256=HEX: een HMAC-SHA256 van TIMESTAMP, een punt en de ruwe body, met je ondertekeningsgeheim. Hash de body precies zoals hij binnenkwam. De webhookreferentie heeft een fragment om te kopiëren.

De eigenaar van de werkruimte kan het tonen in het dashboard; andere leden zien de rest van de webhook. Het kan niet opnieuw worden gegenereerd: verwijder voor een nieuw geheim de webhook en maak een nieuwe aan.

HTTPS op een openbaar adres, tot 2.048 tekens, zonder inloggegevens in de URL. Gewoon http:// werkt voor localhost tijdens de ontwikkeling. Formstep controleert de hostnaam vóór elke bezorging opnieuw, dus een DNS-record dat later naar een intern adres wordt verlegd, wordt alsnog geweigerd.

Verzamel informatie van iedereen.

Publiceer een voorbeeldformulier, vul het in zoals je ontvanger dat zou doen en zie de antwoorden terugkomen. Geen account nodig.

Lees de documentatie