Introduction - Pulsewave

The Pulsewave API is a REST API. It accepts JSON request bodies, returns JSON responses, and uses standard HTTP response codes and verbs.

Base URL

https://api.pulsewave.dev/v1

https://api.sandbox.pulsewave.dev/v1

Resource	Description
Messages	Send and inspect individual email, SMS, and push messages
Templates	Reusable, versioned content rendered into messages
Contacts	People you send messages to
Lists	Named groups of contacts
Domains	Sending domains and their DNS verification status
API Keys	Credentials used to authenticate requests
Webhook Endpoints	URLs that receive event notifications
Events	Read-only log of everything that happened to a message

This reference is generated from our OpenAPI document.

View the raw openapi.json

Every request must include an API key in the Authorization header:

curl https://api.pulsewave.dev/v1/messages \
  -H "Authorization: Bearer pw_live_8f2k9q3m1n7r5t6y4u2i0o8p"

See Authentication for the difference between live and test keys, and how to scope keys to specific permissions.

POST requests that create a resource accept an Idempotency-Key header so they can be safely retried. See Idempotency.

Errors share a consistent shape across every endpoint. See Errors for the full list of error types and codes.