Send Push Notification
send_push_notificationSend an ActivitySmith Push Notification to this account. Optionally target channel slugs.
Normal notification taps use redirection, which accepts HTTP/HTTPS URLs and installed apps' custom URL schemes, such as spotify:// or shortcuts://run-shortcut?name=Example.
Expanded notification actions use actions, up to 4 items. open_url actions accept the same external URLs as redirection. Custom app schemes require iOS app 1.13.4 build 2 or later and the target app to be installed; no web fallback is provided. Unsafe schemes and ActivitySmith's internal scheme are blocked. webhook actions call an HTTPS endpoint with GET or POST and optional JSON body.
media can be combined with redirection, but media cannot be combined with actions.
The result includes notification_id. Pass it to replace_push_notification to update this notification later, for example when an incident you alerted on is resolved.
icon shows an HTTPS image, such as a logo or avatar, next to a smaller ActivitySmith app icon; iOS may hide the subtitle. interruption_level is passive (quiet, no sound), active (default), or time-sensitive (can break through Focus when allowed); use time-sensitive only for things the user must see now. Both require iOS app 1.16.0 or later.
Action examples: [ { "title": "Open Build", "type": "open_url", "url": "https://github.com/acme/web/actions/runs/123" }, { "title": "Chat with Jarvis", "type": "open_url", "url": "shortcuts://run-shortcut?name=Jarvis" }, { "title": "Create Incident", "type": "webhook", "url": "https://hooks.example.com/incidents/create", "method": "POST", "body": { "service": "payments-api", "severity": "high" } } ]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | Optional HTTPS image URL, such as a logo or avatar, shown next to a smaller ActivitySmith app icon. | |
| tags | No | Optional account tags used to organize history. | |
| badge | No | Optional app badge count. | |
| media | No | Optional HTTPS image, audio, or video URL. Can be combined with redirection, but not with actions. | |
| sound | No | Optional APNs sound name, such as default. | |
| title | Yes | Push Notification title. | |
| actions | No | Optional expanded notification actions, up to 4. open_url actions accept HTTP/HTTPS URLs or installed apps' custom URL schemes, such as spotify:// or shortcuts://run-shortcut?name=Example. webhook actions call an HTTPS endpoint with optional GET or POST method and optional JSON body. Do not combine actions with media. | |
| message | No | Optional Push Notification message body. | |
| payload | No | Optional custom JSON payload delivered with the notification. | |
| metadata | No | Optional app-only details: up to 50 string keys (1–100 characters), with string (up to 4000 characters), finite number, or boolean values; 16 KB total. Stored in history, never sent to APNs. No nested values or null. | |
| subtitle | No | Optional subtitle shown with the Push Notification. | |
| redirection | No | Optional normal-tap target. Use an HTTP/HTTPS URL or an installed app's custom URL scheme, such as spotify:// or shortcuts://run-shortcut?name=Example. Custom app schemes require iOS app 1.13.4 build 2 or later. No web fallback. | |
| interruption_level | No | Optional delivery urgency: passive, active (default), or time-sensitive. | |
| target_channel_slugs | No | Optional channel slugs to target. Omit to target the account-wide default delivery scope. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | Yes | ||
| success | Yes | ||
| timestamp | Yes | ||
| users_notified | Yes | ||
| notification_id | No | ||
| devices_notified | Yes | ||
| effective_channel_slugs | Yes |