Formstep

Signert JSON til ditt eget endepunkt

Når målet er din egen backend, en serverless-funksjon eller et verktøy uten innebygd integrasjon, er en webhook integrasjonen. Hver innsending kommer som én JSON-hendelse, nøklet på feltnøkkel, signert slik at du kan bevise at den kom fra Formstep, og forsøkt på nytt til endepunktet ditt sier ja.

Oppdatert

Slik fungerer det

  1. Åpne skjemaets Integrasjoner, velg Webhook og skriv inn URL-en. La koblingen stå tom for å sende alle felt, eller legg til rader for å sende bare noen, under JSON-nøklene du velger. See an example request viser hvordan kroppen endrer seg mens du redigerer.
  2. Kopier signeringshemmeligheten, som starter med whsec_ og vises én gang. Legg til opptil fem egne headere, for eksempel et autorisasjonstoken.
  3. Klikk Turn on Webhook, deretter Send a test event: en signert POST med eksempelsvar og headerne dine, logget i hendelsesloggen som en ekte levering.

Se hele guiden

Det som kommer

Ett omslag for alt Formstep sender: id, type, createdAt, apiVersion, test og data. Under data: skjemaet, innsendingen med id, e-post til den som svarte, tidspunkt, språk og PDF-lenke, et answers-objekt for kode, nøklet på feltnøkkel, og et display-objekt med de samme nøklene som lesbar tekst. Et valgsvar er alternativets nøkkel i answers og etiketten i display. En fil er en liste med nedlastings-URL-er i det ene og filnavn i det andre. En innsending som besvarte en forespørsel legger til en request-blokk med din eksterne id og metadata.

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

Et skjema kan ha flere webhooks. Hver utløses for hver innsending og hver senere redigering, adskilt med type. Slå på Send the field list with every event hvis mottakeren din ikke selv kan kalle fields.list.

Nye forsøk

Enhver 2xx er en suksess. Formstep prøver opptil fem ganger: med én gang, deretter etter minst 1, 2, 4 og 8 minutter, så det siste forsøket kommer omtrent to timer etter det første. 429, 5xx, tidsavbrudd og tilkoblingsfeil forsøkes på nytt, og en lengre Retry-After respekteres. 401, 403 og 404 stanser integrasjonen med én gang og sender e-post til den som satte den opp. Leveringer som har brukt alle fem forsøkene vises i et banner på integrasjonen. Retry all sender dem på nytt og slår en pauset integrasjon på igjen.

Til lokal utvikling kan du eksponere utviklingsserveren din med ngrok eller en Cloudflare-tunnel og peke webhooken dit. For uferdige svar på offentlige lenker oppretter du et submission_abandoned-abonnement med REST API. Webhooken du legger til her utløses aldri for dem.

Et arbeidsflytverktøy med webhook-trigger, som Make eller Pipedream, kan også motta disse. Hvis mottakeren er en arbeidsflyt som venter på én bestemt person, vil du ha en callback på forespørselen i stedet for en webhook: den utløses én gang, for den forespørselen, med utfallet.

Spørsmål om Formstep for Webhooks

Har du noe annet på hjertet? Dokumentasjonen dekker alle innstillinger, og vi svarer på e-post.

En webhook hører til skjemaet og utløses for hver innsending, fra både delingslenker og forespørsler. En callback hører til én forespørsel: URL-en du oppgir som callbackUrl når du oppretter den, kalles én gang når forespørselen avsluttes. Begge bærer det samme hendelsesomslaget.

Hver forespørsel har en X-Formstep-Signature-header på formen t=TIMESTAMP,sha256=HEX: en HMAC-SHA256 av TIMESTAMP, et punktum og den rå kroppen, med signeringshemmeligheten din. Hash kroppen nøyaktig slik den kom. Webhook-referansen har et utdrag du kan kopiere.

Eieren av arbeidsområdet kan vise den i dashbordet. Andre medlemmer ser resten av webhooken. Den kan ikke genereres på nytt: for en ny hemmelighet må du slette webhooken og opprette en ny.

HTTPS på en offentlig adresse, opptil 2048 tegn, uten påloggingsinformasjon i URL-en. Vanlig http:// fungerer for localhost under utvikling. Formstep sjekker vertsnavnet på nytt før hver levering, så en DNS-oppføring som senere peker til en intern adresse blir fortsatt avvist.

Samle inn informasjon fra hvem som helst.

Publiser et eksempelskjema, svar på det som mottakeren din ville gjort, og se svarene komme tilbake. Ingen konto nødvendig.

Les dokumentasjonen