DokumentasjonWebhooks

Webhooks

Webhooks sender meldingshendelser til serveren din i sanntid, så du kan oppdatere dine egne data uten å spørre systemet på nytt hele tiden: logg en leveranse, flagg en retur, reager på en spamklage.

Legg til et endepunkt

Åpne Webhooks → Add endpoint og skriv inn en HTTPS-URL som kan motta POST- forespørsler. Mailhuset sender hver hendelse dit som JSON.

Når du legger til et endepunkt kan du abonnere på bestemte hendelser, eller la listen stå tom for å motta alle sammen.

Hendelser

En hendelse utløses etter hvert som en melding beveger seg gjennom livssyklusen sin:

HendelseBetydning
email.sentOverlevert til mottakerserveren
email.deliveredMottakerserveren aksepterte meldingen
email.bouncedLeveranse feilet (hard retur = permanent, blokkeres automatisk)
email.complainedMottakeren merket den som spam (blokkeres automatisk)
email.openedMottakeren åpnet den (åpningssporing på)
email.clickedMottakeren klikket på en lenke (klikksporing på)
email.rejectedLeverandøren avviste meldingen før sending

Hver nyttelast identifiserer meldingen (messageId), leverandørens meldings-id, hendelsestypen type, og et occurredAt-tidsstempel, så du kan korrelere den med sendingen. Hendelsestypen sendes også i X-Mailhuset-Event-headeren.

Svar raskt og verifiser

  • Returner en 2xx raskt; gjør tungt arbeid asynkront. Mailhuset prøver på nytt

ved feilede leveranser med gradvis økende ventetid, så håndtereren din må være idempotent (samme hendelse kan komme mer enn én gang).

  • Verifiser at hendelser virkelig kommer fra Mailhuset (sjekk signeringshemmeligheten

som vises når du oppretter endepunktet) før du handler på dem.

Returer og klager håndteres for deg

Du trenger ikke blokkere dårlige adresser selv. Harde returer og klager legges automatisk til i blokkeringslisten din. Bruk webhooken til å speile den tilstanden i din egen database.

Testing, leveringslogg og reprise

Hvert leveringsforsøk registreres. På siden Webhooks åpner du Deliveries under et endepunkt for å se nylige forsøk med status, HTTP-koden serveren din returnerte, antall forsøk, og den nøyaktige nyttelasten og svarteksten.

  • Send test event sender en realistisk eksempelhendelse til endepunktet ditt med

en gang og viser resultatet, så du kan koble opp og verifisere håndtereren din før ekte e-post begynner å flyte.

  • Replay sender nyttelasten fra en tidligere hendelse på nytt som en fersk leveranse,

nyttig etter at du har rettet en feil i håndtereren din, eller når serveren din var nede.

  • Disable pauser leveranse til et endepunkt uten å slette det (og historikken);

Enable slår det på igjen.

Du kan også peke et endepunkt mot et verktøy for forespørselsinspeksjon mens du utvikler, sende deg selv en ekte e-post, og se hendelsene komme inn.

Sandbox-modus

Sendinger gjort med en test-API-nøkkel (mh_test_…) eller fra et sandbox-prosjekt simuleres fullt ut: de registreres i meldingsloggen din, men sendes aldri faktisk, så de treffer ikke ekte innbokser, teller ikke mot kvoten din, eller faktureres. Bruk dem til å bygge og teste integrasjonen din ende til ende. Se API-nøkler for testnøkler.


Trenger du hjelp? Send e-post til support@mailhuset.com.