Webhooks

Create a webhook endpoint

Creates a new webhook endpoint that receives event notifications at the specified URL.

post/webhook_endpoints

Request

  • Base URL: https://api.paubox.com/v1/email
  • URL: https://api.paubox.com/v1/email/webhook_endpoints
  • Auth: HTTP bearer

Request body

target_urlstring required

HTTPS URL to receive webhook deliveries. Must not point to a private or internal address.

eventsstring[] required

Event types to subscribe to.

signing_keystring

Included as x-webhook-signing-key header on deliveries for verification.

api_keystring

Included as x-api-key header on deliveries.

activeboolean

Whether the endpoint is active. Defaults to true.

Example request

{
  "target_url": "https://example.com/webhooks/paubox"
}

Response

Webhook endpoint created

messagestring

Example response

{
  "message": "Webhook created!",
  "data": {
    "id": 42,
    "target_url": "https://example.com/webhooks/paubox",
    "events": [
      "inbound_mail_received",
      "api_mail_log_delivered"
    ],
    "active": true,
    "signing_key": "whsec_abc123"
  }
}

Changes

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