Postman Collection

Explore and test the Zyphr API using our pre-built Postman collection.

What's Included

• Full API collection — Every Zyphr API endpoint organized by category (Emails, Push, SMS, Inbox, Subscribers, Devices, Templates, Topics, Webhooks)
• Environment files — Pre-configured for Local, Staging, and Production
• Example payloads — Ready-to-send request bodies for each endpoint

Getting Started

1. Install Postman

Download Postman if you don't have it.

2. Import the Collection

1. Open Postman
2. Click Import (top-left)
3. Import the collection file: postman/Zyphr_API.postman_collection.json

3. Import an Environment

Import the environment file matching your target:

File	Use For
Zyphr_Local.postman_environment.json	Local development (localhost:3000)
Zyphr_Staging.postman_environment.json	Staging (api.staging.zyphr.dev)
Zyphr_Production.postman_environment.json	Production (api.zyphr.dev)

4. Configure Your API Key

1. Select the imported environment in Postman's environment selector (top-right)
2. Click the eye icon to view environment variables
3. Set api_key to your Zyphr API key (e.g., zy_live_your_key or zy_test_your_key)
4. Save

5. Send a Request

1. Expand the Emails folder in the collection
2. Click Send an email
3. Review the pre-filled request body
4. Click Send

Collection Structure

The collection is organized by API category:

Zyphr API/
├── Emails/
│   ├── Send an email
│   ├── Send batch emails
│   ├── List emails
│   ├── Get email details
│   ├── Get email events
│   └── Get email tracking stats
├── Push/
│   ├── Send push notification
│   └── Get push notification details
├── SMS/
│   ├── Send SMS
│   └── Get SMS details
├── Inbox/
│   ├── Send in-app notification
│   ├── Send batch in-app notifications
│   ├── List inbox notifications
│   ├── Mark notification as read
│   ├── Mark all notifications as read
│   └── Get unread count
├── Subscribers/
│   ├── Create or update subscriber
│   ├── List subscribers
│   ├── Get subscriber
│   ├── Update subscriber
│   ├── Delete subscriber
│   ├── Get subscriber preferences
│   └── Update subscriber preferences
├── Devices/
│   ├── Register device
│   ├── List devices
│   ├── Get device
│   └── Unregister device
├── Templates/
│   ├── Create template
│   ├── List templates
│   ├── Get template
│   ├── Update template
│   ├── Delete template
│   ├── Render template preview
│   └── Duplicate template
├── Topics/
│   ├── Create topic
│   ├── List topics
│   ├── Get topic
│   ├── Update topic
│   ├── Delete topic
│   ├── Subscribe to topic
│   ├── Unsubscribe from topic
│   └── List topic subscribers
└── Webhooks/
    ├── Create webhook
    ├── List webhooks
    ├── Get webhook
    ├── Update webhook
    ├── Delete webhook
    ├── Enable webhook
    ├── Disable webhook
    ├── Rotate webhook secret
    ├── List webhook deliveries
    ├── Retry webhook delivery
    └── List available webhook events

Environment Variables

Each environment file includes these variables:

Variable	Description	Example
base_url	API base URL	https://api.zyphr.dev/v1
api_key	Your API key	zy_live_your_key

Tips

• Use Test Mode — Set api_key to a test key (zy_test_...) to simulate requests without sending real messages
• Check Response — Response bodies include meta.request_id for debugging
• Collection Runner — Use Postman's Collection Runner to execute multiple requests in sequence

Downloading

The Postman files are available in the postman/ directory of the Zyphr repository.