Hur skapar jag webhooks i Postal?

När man använder Postal för att skicka ut stora mängder e-post till exempelvis sina kunder kan man ibland vilja samla på sig statistik eller annan data gällande mailen som skickats ut. Det kan röra sig om leveransstatistik, antal klick på länkar i mailen etc. Datan som skickas via en webhook levereras via POST-request i form av organiserad json-data. Denna guide går igenom hur du skapar en webhook via webbgränssnittet för Postal.

Skapa webhook

För att skapa en webhook, gör så här:

1. Börja med att logga in på Postals webbgränssnitt.
2. Klicka dig in på den mailserver du vill skapa en webhook på.
   
3. Klicka på Webhooks i menyn.
   
4. Om du inte skapat några webhooks tidigare, klicka på Add your first webhook.
   
   Har du skapat webhooks tidigare och vill lägga till en ny, klicka istället på Add another webhook.
   
5. Du får nu göra inställningar för den webhook du håller på att skapa.
   
   Fyll i uppgifterna enligt följande:
   
   Name: Här anger du ett namn på din webhook så du kan särskilja flera webhooks.
   
   URL: Här anger du fullständig URL till ditt skript.
   
   Enabled: Om du vill att hooken ska skicka data till URLen angiven ovan, välj Yes - send requests to this webhook.
   
   Events: Här väljer du vilken data som ska skickas till din URL. Standard är att skicka allt (valet Yes - send all events to this URL), men du kan även välja No - I'll choose which requests to send om du bara vill att viss data ska skickas. Du får då välja vad i en meny som dyker upp:
   
   
   Klicka på Create webhook-knappen när du är klar.

Din webhook är nu redo att leverera data till ditt skript.

Exempel på skript

Denna guide täcker inte avancerad kod för hur ett skript kan se ut som tar emot data från en webhook, men detta korta PHP-kodexempel visar hur man kan spara ner all inkommande data till en loggfil:

<?php
    $data = file_get_contents('php://input') . PHP_EOL;
    $file = 'payloads.log';
    file_put_contents($file, $data, FILE_APPEND);
?>

Enligt vårt exempel i stegen ovan ska denna fil sparas som postal-webhook.php och kommer ta emot all data som POSTas mot den till filen payloads.log.

Datan POSTas mot webhookens URL i form av json-data.