SparkPost C# Webhooks Sample

---

The project contains a simple implementation for SparkPost Webhooks that shows how to hook on the events that requires you to unsubscribe the user from the mailing list.

---

Prerequisites

Before using this example, you must have:

• A shiny new SparkPost Account, sign up for a new account or login to SparkPost

• .NET Core Runtime 2.0 installed (Download)

• Visual Studio Code / Visual Studio 2017

Installation

> git clone <repo_url> .
> cd SparkPostWebhooksSample
> dotnet restore
> dotnet ef database update
> dotnet run

Testing The Webhook

• Register the service as SparkPost webhook from your Account then select Events (ex. Bounce, Out of Band, Spam Complaint, List Unsubscribe, Link Unsubscribe) then add the webhook and click the test button to send a test batch.
• With fake data via Postman
• With real data via ngrok by creating a new Webhook on your SparkPost Account that points to the ngrok tunnel address. (but first you need to run ngrok http 5000 on your machine after running the project).

The sample runs on port 5000, so you need to make POST request to the webhook endpoint: http://localhost:5000/api/webhook with the expected payload.

Sample Payload:

• Webhook Ping:

[ { "msys": {} } ]

• Fake Data:

[
        {
            "msys": {
                "message_event": {
                    "type": "bounce",
                    "bounce_class": "1",
                    "campaign_id": "Example Campaign Name",
                    "customer_id": "1",
                    "delv_method": "esmtp",
                    "device_token": "45c19189783f867973f6e6a5cca60061ffe4fa77c547150563a1192fa9847f8a",
                    "error_code": "554",
                    "event_id": "92356927693813856",
                    "friendly_from": "[email protected]",
                    "ip_address": "127.0.0.1",
                    "ip_pool": "Example-Ip-Pool",
                    "message_id": "000443ee14578172be22",
                    "msg_from": "[email protected]",
                    "msg_size": "1337",
                    "num_retries": "2",
                    "rcpt_meta": {
                        "customKey": "customValue"
                    },
                    "rcpt_tags": [
                        "male",
                        "US"
                    ],
                    "rcpt_to": "[email protected]",
                    "raw_rcpt_to": "[email protected]",
                    "rcpt_type": "cc",
                    "raw_reason": "MAIL REFUSED - IP (17.99.99.99) is in black list",
                    "reason": "MAIL REFUSED - IP (a.b.c.d) is in black list",
                    "routing_domain": "example.com",
                    "sending_ip": "127.0.0.1",
                    "sms_coding": "ASCII",
                    "sms_dst": "7876712656",
                    "sms_dst_npi": "E164",
                    "sms_dst_ton": "International",
                    "sms_src": "1234",
                    "sms_src_npi": "E164",
                    "sms_src_ton": "Unknown",
                    "subaccount_id": "101",
                    "subject": "Summer deals are here!",
                    "template_id": "templ-1234",
                    "template_version": "1",
                    "timestamp": "1454442600",
                    "transmission_id": "65832150921904138"
                }
            }
        }
]