Skip to main content
POST

Authorizations

Authorization
string
header
required

Paubox API uses Bearer token authentication in the Authorization header.

Format: Authorization: Bearer YOUR_API_KEY_HERE

Example: Authorization: Bearer 9e5b092b632445b8f570c62ae54f30fda1044305

The legacy format Authorization: Token token=YOUR_API_KEY_HERE is also supported.

Body

application/json
target_url
string
required

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

Example:

"https://example.com/webhooks/paubox"

events
enum<string>[]
required

Event types to subscribe to.

Available options:
api_mail_log_delivered,
api_mail_log_opened,
api_mail_log_temporary_failure,
api_mail_log_permanent_failure,
inbound_mail_received
signing_key
string

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

api_key
string

Included as x-api-key header on deliveries.

active
boolean
default:true

Whether the endpoint is active. Defaults to true.

Response

Webhook endpoint created

message
string
Example:

"Webhook created!"

data
object