SparkPost · Example Payload

Sparkpost Create Webhook Example

Example: Create a webhook for delivery and bounce events

EmailTransactional EmailMarketing EmailEmail DeliverySMTPWebhooksAnalyticsTemplatesSuppression List

Sparkpost Create Webhook Example is an example object payload from SparkPost, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionrequestresponse

Example Payload

{
  "description": "Example: Create a webhook for delivery and bounce events",
  "request": {
    "method": "POST",
    "url": "https://api.sparkpost.com/api/v1/webhooks",
    "headers": {
      "Authorization": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    "body": {
      "name": "Production Event Webhook",
      "target": "https://webhook.myapp.com/sparkpost-events",
      "events": [
        "delivery",
        "bounce",
        "out_of_band",
        "spam_complaint",
        "open",
        "click",
        "link_unsubscribe"
      ],
      "active": true,
      "auth_type": "basic",
      "auth_credentials": {
        "username": "webhook_user",
        "password": "s3cur3p@ssw0rd"
      },
      "custom_headers": {
        "X-Webhook-Source": "sparkpost",
        "X-Environment": "production"
      }
    }
  },
  "response": {
    "status": 200,
    "body": {
      "results": {
        "id": "a2b83904-00d4-4a8c-9c72-0e8dc3f2a1b5"
      }
    }
  }
}