Programmatic Push API

For developers, HyperPush X provides a REST API to trigger push notifications directly from your backend services.

🔑 Obtaining your API Credentials

1. Go to the API Keys tab in the dashboard.
2. Click Generate New Key.
3. Keep this key secure. Use it in the Authorization header of your HTTP requests.

🚀 Dispatching a Push Notification

Make a POST request to the campaign dispatch endpoint:

• Endpoint: POST https://hyperpushx.com/api/v1/campaigns/send
• Headers:

  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json
  

• Payload Format:

  {
    "title": "Transactional Update",
    "message": "Your order #10482 has been shipped! 📦",
    "url": "https://yoursite.com/orders/10482",
    "segment_id": "optional-segment-uuid"
  }
  

🔄 Tracking Delivery Webhooks

Configure webhook endpoints under your website settings to receive automated JSON reports whenever push notifications are successfully delivered, clicked, or bounced (flagged as expired).