Schemas

Download schema

NotificationChannel

type

string · enum · required

Enum values:

sms

push

in-app

Example: email

data

object · required

templateName

string · required

The template identifier

Example: fintech-alert

message

string · required

title

string · required

The title of the notification (for logging and mock strategy)

Example: Deposit Received

link

string · required

Notification link (e.g., URL or deep link). Optional and can be used for logging or mock strategy.

Example: https://example.com/deposit-received

SendNotificationDto

tenantId

string · required

The UUID of the tenant

Example: b1aabc99-9c0b-4ef8-bb6d-6bb9bd380a11

userId

string · required

The UUID of the target user

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

priority

number · enum · required

Enum values:

Example: 10

object[] · required

scheduledAt

string

ISO Date string. MUST include timezone (Z or offset). E.g., 2026-02-25T11:05:00Z or 2026-02-25T11:05:00+08:00

Example: 2026-02-25T11:05:00+08:00

metadata

object

CreateProviderConfigDto

channel

string · enum · required

Enum values:

sms

push

in-app

Example: email

providerId

string · required

Internal identifier for the provider

Example: sendgrid

credentials

object · required

JSON object containing the provider API keys/credentials

Example: {"user":"apikey","pass":"SG.12345..."}

isActive

boolean · required

Set to true to make this the active provider for the channel

Example: true

UpdateProviderConfigDto

channel

string · enum

Enum values:

sms

push

in-app

Example: email

providerId

string

Internal identifier for the provider

Example: sendgrid

credentials

object

JSON object containing the provider API keys/credentials

Example: {"user":"apikey","pass":"SG.12345..."}

isActive

boolean

Set to true to make this the active provider for the channel

Example: true

CreateTemplateInputDTO

name

string · required

Name of the template

content

string · required

Content of the template

status

string · enum · required

Status of the template

Enum values:

active

inactive

archived

pending

Default: pending

type

string · enum · required

Type of the template

Enum values:

sms

push

projectData

object

JSON object of grapejs which contains the project data for the template.

Example: {"key1":"value1","key2":"value2"}

RegisterUserDto

fcmToken

string · required

email

string · required

userId

string · required

phoneNumber

string · required

UpsertTenantDto

id

number · required

The internal ID of the tenant

Example: 9

tenant_id

string · required

The UUID of the tenant

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

The name of the tenant

Example: Tenant Name

UpsertSubscriberDto

tenant_id

string · required

The UUID of the tenant

Example: 550e8400-e29b-41d4-a716-446655440000

keycloak_uuid

string · required

The UUID of the subscriber in Keycloak

Example: 550e8400-e29b-41d4-a716-446655440001

email

string · required

The email of the subscriber

Example: user@example.com

first_name

string · required

The first name of the subscriber

Example: John

last_name

string · required

The last name of the subscriber

Example: Doe

phone_number

string · required

The phone number of the subscriber

Example: +1234567890

type

string · required

The type of the subscriber

Example: subscriber

status

string · required

The status of the subscriber

Example: active

__deleted

string · required

Indicates if the subscriber is deleted

Example: false

NotificationChannel

type

string · enum · required

Enum values:

sms

push

in-app

Example: email

data

object · required

templateName

string · required

The template identifier

Example: fintech-alert

message

string · required

title

string · required

The title of the notification (for logging and mock strategy)

Example: Deposit Received

link

string · required

Notification link (e.g., URL or deep link). Optional and can be used for logging or mock strategy.

Example: https://example.com/deposit-received

SendNotificationDto

tenantId

string · required

The UUID of the tenant

Example: b1aabc99-9c0b-4ef8-bb6d-6bb9bd380a11

userId

string · required

The UUID of the target user

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

priority

number · enum · required

Enum values:

Example: 10

object[] · required

scheduledAt

string

ISO Date string. MUST include timezone (Z or offset). E.g., 2026-02-25T11:05:00Z or 2026-02-25T11:05:00+08:00

Example: 2026-02-25T11:05:00+08:00

metadata

object

CreateProviderConfigDto

channel

string · enum · required

Enum values:

sms

push

in-app

Example: email

providerId

string · required

Internal identifier for the provider

Example: sendgrid

credentials

object · required

JSON object containing the provider API keys/credentials

Example: {"user":"apikey","pass":"SG.12345..."}

isActive

boolean · required

Set to true to make this the active provider for the channel

Example: true

UpdateProviderConfigDto

channel

string · enum

Enum values:

sms

push

in-app

Example: email

providerId

string

Internal identifier for the provider

Example: sendgrid

credentials

object

JSON object containing the provider API keys/credentials

Example: {"user":"apikey","pass":"SG.12345..."}

isActive

boolean

Set to true to make this the active provider for the channel

Example: true

CreateTemplateInputDTO

name

string · required

Name of the template

content

string · required

Content of the template

status

string · enum · required

Status of the template

Enum values:

active

inactive

archived

pending

Default: pending

type

string · enum · required

Type of the template

Enum values:

sms

push

projectData

object

JSON object of grapejs which contains the project data for the template.

Example: {"key1":"value1","key2":"value2"}

UpsertSubscriberDto

tenant_id

string · required

The UUID of the tenant

Example: 550e8400-e29b-41d4-a716-446655440000

keycloak_uuid

string · required

The UUID of the subscriber in Keycloak

Example: 550e8400-e29b-41d4-a716-446655440001

email

string · required

The email of the subscriber

Example: user@example.com

first_name

string · required

The first name of the subscriber

Example: John

last_name

string · required

The last name of the subscriber

Example: Doe

phone_number

string · required

The phone number of the subscriber

Example: +1234567890

type

string · required

The type of the subscriber

Example: subscriber

status

string · required

The status of the subscriber

Example: active

__deleted

string · required

Indicates if the subscriber is deleted

Example: false