Skip to content

PushWard API Reference

The full REST reference for the PushWard iOS Live Activity API, notifications, and widgets. Explore every endpoint below, or read the API guide for authentication and worked examples.

Endpoints

All paths are relative to https://api.pushward.app

Activities

  • GET /activities List activities
  • POST /activities Create activity
  • GET /activities/{slug} Get activity
  • PATCH /activities/{slug} Update activity
  • DELETE /activities/{slug} Delete activity

Auth

  • GET /auth/me Get current user profile

Email

  • POST /emails Send transactional email

System

  • GET /health Health check no auth

Integration Keys

  • GET /integrations/keys List integration keys
  • POST /integrations/keys Create integration key
  • PATCH /integrations/keys/{key_id} Update integration key
  • DELETE /integrations/keys/{key_id} Revoke integration key
  • POST /integrations/keys/{key_id}/roll Roll integration key

Notifications

  • POST /notifications Create notification
  • GET /notifications/answers/{id} Get notification answer
  • GET /notifications/receipts/{id} Get notification receipt
  • POST /notifications/receipts/{id}/cancel Cancel notification receipt
  • POST /notifications/receipts/cancel Cancel notification receipts by tag
  • GET /notifications/scheduled List scheduled notifications
  • POST /notifications/scheduled Schedule notification
  • GET /notifications/scheduled/{id} Get scheduled notification
  • DELETE /notifications/scheduled/{id} Cancel scheduled notification

Widgets

  • GET /widgets List widgets
  • POST /widgets Create widget
  • GET /widgets/{slug} Get widget
  • PATCH /widgets/{slug} Update widget
  • DELETE /widgets/{slug} Delete widget