← Back to Docs

Custom Sounds

Use built-in or custom alert sounds for your notifications.

Using a Built-in Sound

Pass the sound field with the name of an iOS system sound:

curl -X POST https://api.notfs.dev/api/notifications \
  -H "X-API-Key: ntfs_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Build Complete",
    "body": "All 248 tests passed.",
    "sound": "chime.caf"
  }'

Default Sound

If you omit the sound field, iOS uses the default notification sound. To send a silent push, set sound to an empty string.

Available System Sounds

Sound NameDescription
defaultiOS default notification sound
chime.cafGentle chime
alarm.cafAlarm tone
glass.cafGlass tap
hero.cafHero sound effect
morse.cafMorse code beep

Custom Bundle Sounds

If you're building your own fork of the iOS app, you can add custom .caf or .aiff files to the app bundle and reference them by filename in the sound field:

# Convert MP3 to CAF
afconvert input.mp3 output.caf -d ima4 -f caff

# Use in API call
"sound": "output.caf"

Sound files must be under 30 seconds. iOS will fall back to the default sound if the file is not found in the bundle.