← Back to Docs
Quick Start
Send yourself a push notification in under a minute.
1
Create an Account
Sign up via the API or the iOS app. Store the JWT token from the response.
curl -X POST https://api.notfs.dev/api/auth/register \
-H "Content-Type: application/json" \
-d '{
"email": "you@example.com",
"password": "min8chars",
"name": "Your Name"
}'2
Create an API Key
Use the token from step 1 to create an API key. You can also do this from the app's Settings > API Keys screen.
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"]
}'⚠️ The full API key is only shown once. Copy and store it securely.
3
Install the iOS App
Download notfs from the App Store, sign in with the same account, and allow push notifications when prompted. The app automatically registers your device.
4
Send a Notification
Use your API key to send a push notification. It will arrive on your device within seconds.
curl -X POST https://api.notfs.dev/api/notifications \
-H "X-API-Key: ntfs_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"title": "Hello from notfs!",
"body": "Your first push notification",
"sound": "default",
"delay": "5s"
}'Response
{
"id": "clx...",
"title": "Hello from notfs!",
"body": "Your first push notification",
"status": "QUEUED",
"scheduledAt": "2026-02-15T12:00:05.000Z",
"createdAt": "2026-02-15T12:00:00.000Z",
"devicesTargeted": 1
}