Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

All requests must include Authorization: Bearer <api_key>. Keys are prefixed pw_live_ or pw_test_. See Authentication.

Body

application/json
url
string<uri>
required
Example:

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

enabled_events
enum<string>[]
required

Pass ["*"] to receive every event type

Available options:
message.sent,
message.delivered,
message.bounced,
message.opened,
message.clicked,
message.complained,
contact.unsubscribed,
domain.verified

Response

The created webhook endpoint, including its signing secret

id
string
Example:

"we_9k2m5p"

object
enum<string>
Available options:
webhook_endpoint
url
string<uri>
enabled_events
enum<string>[]
Available options:
message.sent,
message.delivered,
message.bounced,
message.opened,
message.clicked,
message.complained,
contact.unsubscribed,
domain.verified
status
enum<string>
Available options:
enabled,
disabled
created_at
string<date-time>
secret
string

Signing secret used to verify the Pulsewave-Signature header. Only returned once.

Example:

"whsec_3f8a2k9q1m7r5t6y"