TriggerRequest

A request to send one notification.

categorystring | nullnullable

Preference category this notification belongs to — for example marketing or receipts.

Matched against the keys of a subscriber's categories preferences, so a subscriber who has muted marketing still receives everything else. Defaults to name when omitted, which means an unlabelled workflow can still be muted by its own name.

Example: receipts

namestringrequired

Workflow name to run, as configured in your Nerve workspace.

Example: payment-received

overrides object

oneOf

• null
• ProviderOverridesDto

null

payloadobject | nullnullable

Template variables. Any JSON object; keys are referenced from your templates as {{key}}.

to objectrequired

The recipient and their contact details.

deviceTokensstring[]nullable

FCM or APNs device tokens for the push channel.

emailstring | nullnullable

Email address for the email channel.

Example: ada@example.com

phonestring | nullnullable

E.164 phone number for the sms, whatsapp and voice channels.

Example: +2348012345678

subscriberIdstringrequired

Your stable identifier for the end user. Also the rate-limit bucket and the last segment of the NATS subject the event is published to.

Example: user_8f21c

TriggerRequest

{
  "category": "receipts",
  "name": "payment-received",
  "overrides": "null",
  "payload": "Unknown Type: object,null",
  "to": {
    "deviceTokens": "Unknown Type: array,null",
    "email": "ada@example.com",
    "phone": "+2348012345678",
    "subscriberId": "user_8f21c"
  }
}