API ReferenceWebhooksCreate Webhook

Create Webhook

POSThttps://wapi.simplysend.email/web-setup/webhooks

Parameters

nameRequired

string

A friendly name for your webhook integration.

urlRequired

string

The publicly accessible HTTPS URL where Simply Send will send event payloads.

eventsRequired

array

List of event types to subscribe to. See the Valid Event Types overview for available options.

isActive

boolean

Whether the webhook is active. Defaults to true.

headers

object

Custom key-value pairs to be included in the header of every webhook request.

RequestPOST

curl -X POST https://wapi.simplysend.email/web-setup/webhooks \
  -H "X-Api-Key: your_api_key" \
  -H "X-Id: your_account_id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Production Analytics",
  "url": "https://your-server.com/webhooks/simply-send",
  "events": [
    "email_delivered"
  ],
  "isActive": true
}'

Response

{
  "success": true,
  "data": {
    "webhookId": "webhook_1772354412494_02cb8b58",
    "name": "Production Analytics",
    "url": "https://your-server.com/webhooks/simply-send",
    "events": [
      "email_delivered"
    ],
    "isActive": true,
    "secret": "whsec_390c02493899eea9059e356d886a2eeebe882500943992100340e5fae6956518",
    "createdAt": 1772354412494,
    "message": "Webhook created successfully"
  }
}