跳至內容

快速入門

在 5 分鐘內開始向您的 iPhone 發送推播通知。

1. Install the iOS App

Download PushWard from the App Store on your iPhone running iOS 26 or later.

將在 app 版本 1.5.0 中推出

本節介紹的功能來自一個正在等待 App Store 審核的 app 更新。更新上線後，此處會自動解鎖。

ℹ 資訊

PushWard requires iOS 26+ for Live Activity support.

2. Sign In and Get Your Key

Open the app and sign in with your Apple ID. This creates your PushWard account and automatically generates a default integration key (hlk_) with full activity management access and every capability enabled — push notifications, widgets, and email — so it works with every endpoint out of the box.

Copy your integration key from the app's settings screen. You'll need it for all API requests.

💡 提示

For production use, create separate integration keys in the iOS app with scoped access for each service instead of sharing the default key.

3. Create an Activity

Activities are the things you want to track on your Lock Screen. Each activity has a unique slug and a display name.

建立一個 activity 
curl -X POST https://api.pushward.app/activities \
  -H "Authorization: Bearer hlk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "my-build",
    "name": "My Build"
  }'

The activity starts in the ended state. Your devices are automatically subscribed.

4. Start a Live Activity

Send your first push notification by updating the activity state to ongoing. This starts a Live Activity on your device's Lock Screen.

啟動即時動態 
curl -X PATCH https://api.pushward.app/activities/my-build \
  -H "Authorization: Bearer hlk_YOUR_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
    "state": "ongoing",
    "content": {
      "template": "generic",
      "progress": 0.0,
      "state": "Starting...",
      "icon": "arrow.triangle.branch",
      "accent_color": "cyan"
    }
  }'

5. Update and End

Send updates to change the progress and status text. End the activity when you're done.

更新進度 
curl -X PATCH https://api.pushward.app/activities/my-build \
  -H "Authorization: Bearer hlk_YOUR_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
    "state": "ongoing",
    "content": {
      "template": "generic",
      "progress": 0.75,
      "state": "Running tests...",
      "icon": "arrow.triangle.branch",
      "accent_color": "cyan"
    }
  }'
結束即時動態 
curl -X PATCH https://api.pushward.app/activities/my-build \
  -H "Authorization: Bearer hlk_YOUR_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
    "state": "ended",
    "content": {
      "template": "generic",
      "progress": 1.0,
      "state": "Complete",
      "icon": "checkmark.circle.fill",
      "accent_color": "green"
    }
  }'
💡 提示

After ending, the Live Activity remains visible on the Lock Screen for up to 4 hours (iOS behavior). The activity returns to ended state and can be started again.

Next Steps