Skip to main content

SendNotificationRequest

typestringrequired

The notification type key registered under your app

Example: payment_reminder
user_idstringrequired

The recipient user's id

Example: 1VJEQAYWW54TZ5VD
subjectstringrequired

Possible values: <= 255 characters

Example: Your registration payment is due
bodystringrequired

Plain text body. Used by email (fallback), telegram, and bell channels.

Possible values: <= 10000 characters

Example: You have 7 days to complete payment.
htmlstringnullable

Optional HTML body used only by the email channel.

Example: <p>You have <strong>7 days</strong>...</p>
cta objectnullable

Optional call-to-action button. Both label and url must be provided together.

labelstringrequired

Possible values: <= 255 characters

Example: Pay now
urlstring<uri>required

Possible values: <= 2048 characters

Example: https://reg.eurofurence.org/pay
SendNotificationRequest
{
"type": "payment_reminder",
"user_id": "1VJEQAYWW54TZ5VD",
"subject": "Your registration payment is due",
"body": "You have 7 days to complete payment.",
"html": "<p>You have <strong>7 days</strong>...</p>",
"cta": {
"label": "Pay now",
"url": "https://reg.eurofurence.org/pay"
}
}