Quickstart

Send your first notification in under 10 minutes

Follow this guide to sign up, configure a channel provider, design a template, and dispatch your first notification.

1. Create your Account

   Sign up on the Notifyflow Dashboard to create a tenant profile. Your new profile automatically initializes with a unique public API key.

2. Configure your Resend API Key

   Navigate to the Providers section in the sidebar. Click Configure under Email Delivery, select Resend, and paste your Resend API Key.

   Resend provides free API keys on registration. Ensure you configure a valid fromEmail matching your verified domain to send to any recipient address.

3. Create a Template

   Navigate to the Template Manager in the sidebar. Click New Template and create a template with the following details:

   • Name: welcome_onboarding
   • Channel: EMAIL
   • Email Subject: Welcome {{ name }} to Acme Corp!
   • Message Body: Hi {{ name }}, we are thrilled to welcome you to the team. Let us know if you need anything!
4. Dispatch via cURL

   Use the cURL snippet below to trigger a post request, replacing nf_live_xxxxxxxxxxxx with your public API key (available in Settings):

   curl -X POST https://notifyflow-api.onrender.com/api/v1/notify \
     -H "Content-Type: application/json" \
     -H "x-api-key: nf_live_your_api_key_here" \
     -d '{
       "channel": "EMAIL",
       "recipient": "[e-mail]",
       "template": "welcome_onboarding",
       "data": {
         "name": "Sarah Jones"
       }
     }'
   
5. Inspect in the Dashboard

   Head back to the Overview dashboard page. You will see the counter increment, and the notification logs list will display the new row matching your request. Tap the log card to view delivery attempts.

Ingestion Response

A successful submission yields an HTTP 202 Accepted response acknowledging the pipeline has ingested the request:

{
  "notificationId": "notif_01HX8A99B99E7F6B",
  "status": "queued"
}