Webhooks

Create a webhook

Configure a new webhook to track email events.

post/v2/email-service/webhook

Request

  • Base URL: https://api.sendpulse.com
  • URL: https://api.sendpulse.com/v2/email-service/webhook
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.sendpulse.com/oauth/access_token)

Request body

urlstring required
actionsstring[] required

Example request

{
  "url": "https://site.com/callback",
  "actions": [
    "delivered"
  ]
}

Response

Webhook created

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "id": 162242,
      "user_id": 7043663,
      "url": "https://site.com/callback",
      "action": "unsubscribe"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.