Quickstart

Get your first notification delivered in under 5 minutes.

Prerequisites

• A FlowAlert account — sign up at app.flowalert.io (opens in a new tab)
• The FlowAlert mobile app installed (App Store · Google Play)
• A terminal or HTTP client

Step 1 — Create an API key

In the dashboard, go to Setup → API Keys and create a new key. Copy it — you'll use it in the next step.

Step 2 — Send an event

Replace <your-api-key> with the key you just created:

curl -X POST https://api.flowalert.io/v1/events \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <your-api-key>" \
  -d '{
    "event": "test.ping",
    "title": "Hello from FlowAlert",
    "body": "Your first event is working.",
    "priority": "NORMAL"
  }'

You should see the event appear in Dashboard → Alerts within a few seconds.

Step 3 — Create a group

Go to Setup → Groups and create a group (e.g. "My Team"). Add yourself to it.

Step 4 — Create a routing rule

Go to Setup → Routing Rules and create a rule:

• Event key pattern: test.ping (or * to match all events)
• Notify group: the group you just created
• Requires acknowledgement: optional

Step 5 — Receive the notification

Send the curl command again. Within a few seconds, your phone should receive a push notification.

Next steps

• Event payload reference — all available fields
• Routing rule conditions — match on priority, branch, and more
• WordPress integration — send events from your WordPress site