Skip to Content
API ReferenceEvent DestinationsCreate event destination

Create event destination

Add a webhook destination to a configuration set. Events from sends referencing the config set will be POSTed to your URL with an HMAC-signed body.

POST /api/v1/partner/email/configuration-sets/:id/event-destinations

Request body

{ "name": "production-webhook", "destination_type": "WEBHOOK", "webhook_url": "https://yourapp.com/webhooks/email", "webhook_secret": "your-shared-secret-min-16-chars", "matching_event_types": ["send", "delivered", "bounce", "complaint", "open", "click"], "enabled": true }
FieldTypeRequiredNotes
namestringyesFriendly identifier
destination_typestringnoWEBHOOK only (KAFKA, SNS — roadmap)
webhook_urlstringyesHTTPS endpoint. Must respond 2xx within 10s
webhook_secretstringnoHMAC-SHA256 signing key. Saved write-only — never echoed back
matching_event_typesstring[]noSubscribe to specific events. Empty = subscribe to everything
enabledboolnoDefault true. Set false to pause without deleting

Valid event types:

  • send, delivered, bounce, complaint
  • open, click, reject
  • rendering_failure, delivery_delay

Response

{ "success": true, "destination_id": "ed_550e8400-...", "name": "production-webhook", "webhook_url": "https://yourapp.com/webhooks/email", "matching_event_types": ["send", "delivered", "bounce", "complaint", "open", "click"], "enabled": true }

cURL

curl https://apis.splashifypro.com/api/v1/partner/email/configuration-sets/cs_.../event-destinations \ -H "Authorization: Bearer $SPLASHIFY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "production-webhook", "destination_type": "WEBHOOK", "webhook_url": "https://yourapp.com/webhooks/email", "webhook_secret": "...", "matching_event_types": ["send", "delivered", "bounce", "complaint", "open", "click"] }'

Common errors

StatusCodeMeaning
400INVALID_REQUESTMissing webhook_url or unknown event type
400WEBHOOK_URL_INVALIDURL must be HTTP(S)