n
notfs
← Back to Docs

iOS App Setup

Install and configure the notfs iOS app to receive push notifications.

1

Install

Download notfs from the App Store. Requires iOS 17 or later.

2

Sign In

Create an account or sign in with your existing notfs credentials. The app uses the same account as the API.

3

Allow Notifications

When prompted, tap "Allow" for push notifications. This registers your device with APNs and the notfs backend automatically. You can manage permissions later in iOS Settings.

4

Get Your API Key

Go to Settings > API Keys in the app to create a key. Or create one via the API:

curl -X POST https://api.notfs.dev/api/keys \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"My Key","scopes":["notifications:read","notifications:write"]}'
5

Send Your First Notification

curl -X POST https://api.notfs.dev/api/notifications \
  -H "X-API-Key: ntfs_your_key" \
  -H "Content-Type: application/json" \
  -d '{"title":"Hello!","body":"Push from CLI","delay":"5s"}'

App Features

Create — Schedule notifications with custom titles, sounds, icons, and delays

History — View all sent notifications with delivery status

API Keys — Create and manage API keys with custom scopes

Settings — Manage your account, devices, and notification preferences