Notifications

Manage the notification records stored on a form. These are available for external integrations and reference.

⚠️

Important: The /notifications endpoint stores notification config records, but they do not trigger emails on form submission. Submission emails are driven by settings.emailNotifications (admin alerts) and settings.confirmationEmail (autoresponder to submitter). Configure those via PUT /v1/forms/:id.

Get Notifications

forms.view

GET/v1/forms/:id/notifications

curl

curl "https://proforms.io/api/v1/forms/f_abc123/notifications" \
  -H "Authorization: Bearer pf_your_api_key"

200 OK

{
  "success": true,
  "data": {
    "notifications": [
      {
        "id": 1,
        "type": "email",
        "enabled": true,
        "recipients": [
          "admin@example.com",
          "team@example.com"
        ],
        "subjectTemplate": "New submission: {form_name}",
        "bodyTemplate": null,
        "replyTo": "{email}",
        "fromName": "ProForms",
        "includeData": true
      }
    ]
  }
}

Update Notifications

forms.edit

PUT/v1/forms/:id/notifications

Send the full array of notification configs. Existing notifications are replaced.

Notification Object

Parameter	Type	Description
type*	string	"admin" for admin alert emails, "autoresponder" for confirmation emails to the submitter
enabled*	boolean	Whether this notification record is active
recipients	string	Comma-separated email addresses (admin type only)
subjectTemplate	string	Email subject — supports merge tags like {form_name}, {name}
bodyTemplate	string	Custom email body — supports merge tags (null = default template)
replyTo	string	Reply-to address — supports merge tags like {email}
fromName	string	Sender display name
includeData	boolean	Include submission field data in the email (default: true)

curl

curl -X PUT "https://proforms.io/api/v1/forms/f_abc123/notifications" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "notifications": [
      {
        "type": "email",
        "enabled": true,
        "recipients": ["admin@example.com"],
        "subjectTemplate": "New lead from {form_name}",
        "replyTo": "{email}",
        "fromName": "My Website",
        "includeData": true
      }
    ]
  }'

💡

Merge tags let you include submission data in notifications. Use {field_key} to reference any form field by its key, plus system tags like {form_name}, {site_name}, {submission_date}, {reference_id}, and {form_summary}.