Notifications
Market: US, UK, CEE
Send SMS or email notifications via HTTP through third-party services or SMTP.
Available Connectors
| Connector | Channels | Description |
|---|---|---|
| Twilio | SMS, Email | Transactional and campaign emails/SMS. Includes Verify Service (multi-channel OTP). |
| Vonage | SMS | SMS for client communications. Includes Verify Service (multi-channel OTP). |
| Brevo (SendinBlue) | Transactional and campaign emails with unsubscribe features. |
Additional providers supported via configuration: SendGrid (email) and SMTP (direct email protocol).
Exposed Endpoints
- Send SMS notification:
POST /api/notifications/v1/sms/send - Send email notification:
POST /api/notifications/v1/email/send
Required Headers
- X-Communication-Channel: 1 for SMS, 2 for email
- X-Sender-Id: Constant value "fintechOSrealm"
Vault Configuration
Copy
{
"notificationConfigurations": [
{
"realmId": "fintechOSrealm",
"provider-configurations": [
{
"url": "string",
"provider": "TWILIO" | "SENDINBLUE" | "VONAGE" | "SENDGRID" | "SMTP",
"payload-template": "string",
"communication-channel": "email" | "sms",
"defaultSender": "string",
"authentication": {
"username": "string",
"password": "string",
"key": "string"
}
}
]
}
]
}SMS Request
/api/notifications/v1/sms/send
Request model:
Copy
{
"sender": "string",
"message": "string",
"receiver": "string"
}Sample request:
Copy
{
"sender": "+40732456789",
"message": "Hello world!",
"receiver": "+40732456789"
}Email Request
/api/notifications/v1/email/send
Request model:
Copy
{
"sender": "string",
"message": "string",
"receiver": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"contentType": "text/plain" | "text/html",
"attachmentList": [
{
"name": "string",
"content": "string"
}
]
}Sample request:
Copy
{
"sender": "sender@mail.com",
"message": "Hello world!",
"receiver": "receiver@mail.com",
"subject": "Subject",
"cc": "cc@mail.com",
"bcc": "bcc@mail.com",
"contentType": "text/plain",
"attachmentList": [
{
"name": "file.pdf",
"content": "aGVsbG8="
}
]
}