Notifuse icon

Notifuse

Interact with the Notifuse API

Transactional → Send

AI-generated

Summary

Send a transactional notification via specified channels to a recipient using a notification template ID.

Inputs

  • Notification ID (required) — ID of the notification template to send
  • Contact Email (required) — Email address of the recipient contact
  • Channels (required) — Channels to send the notification through (currently only 'email' supported)
  • Template Data — Key/value pairs passed to the template to populate notification content
  • Email Options — Optional email sending options such as Bcc, Cc, From name, Reply-To, Subject override, Subject preview, and attachments in JSON
  • Metadata — Key/value metadata associated with the notification for tracking
  • Additional Fields — Optional additional attributes for the contact and notification, including external IDs, name fields, phone, language, and timezone

Output shape

a single JSON object representing the API response from sending the transactional notification

The response will contain details of the sent notification as returned by the Notifuse API endpoint /api/transactional.send. Errors can be thrown if the API call fails.

Examples

Example 1: Sending a transactional email notification

Provide a notification template ID, recipient email, channels as ['email'], optional template data key-values, optional email options like subject overrides, optional metadata, and any additional contact or notification fields to customize the send.

Links

Discussion