ConvergeERP.Shared.Notification 0.0.2-beta

ConvergeERP.Shared.Notification

Shared integration event contracts for ConvergeERP notification workflows.

What This Package Contains

• Notification request contract used by other services to ask notification-service to send a notification.
• Notification status contracts for successful and failed delivery updates.
• Shared enums for channel and priority values.

Namespace roots:

• ConvergeERP.Shared.Notification.Events.IntegrationEvents
• ConvergeERP.Shared.Notification.Enums

Event Contracts

SendNotificationIntegrationEvent

Use this event to request notification delivery.

Properties on this contract:

• RecipientUserId
• ToEmail
• ToName
• ToPhone
• Subject
• Body
• TemplateCode
• TemplateData
• Attachments (optional, preferred for file payloads)
• IsHtml
• Channel
• Priority

Also inherits common event metadata via VersionedIntegrationEvent and IntegrationEvent:

• Id
• TenantId
• CompanyId
• CorrelationId
• CreationDate
• OccurredOn
• SchemaVersion (default "1.0")

SendNotificationAttachment

Attachment payload for SendNotificationIntegrationEvent.

• FileName
• MimeType
• Content (base64)

NotificationSentIntegrationEvent

Published when delivery succeeds.

• NotificationId
• Channel
• Recipient
• SentAt
• ProviderMessageId

NotificationFailedIntegrationEvent

Published when delivery fails.

• NotificationId
• Channel
• Recipient
• ErrorMessage
• FailedAt
• RetryCount
• WillRetry
• NextRetryAt

Enums

NotificationChannel

• Email = 1
• SMS = 2
• InApp = 4

NotificationPriority

• Low = 1
• Normal = 2
• High = 3
• Urgent = 4

Publishing Example (MassTransit)

using ConvergeERP.Shared.Notification.Enums;
using ConvergeERP.Shared.Notification.Events.IntegrationEvents;
using MassTransit;

public sealed class OrderService
{
    private readonly IPublishEndpoint _publishEndpoint;

    public OrderService(IPublishEndpoint publishEndpoint)
    {
        _publishEndpoint = publishEndpoint;
    }

    public async Task PublishWelcomeAsync(Guid tenantId, Guid companyId, string email, string firstName, CancellationToken ct)
    {
        await _publishEndpoint.Publish(new SendNotificationIntegrationEvent
        {
            TenantId = tenantId,
            CompanyId = companyId,
            CorrelationId = Guid.CreateVersion7(),
            ToEmail = email,
            ToName = firstName,
            Subject = "Welcome to ConvergeERP",
            TemplateCode = "USER_WELCOME",
            TemplateData = new Dictionary<string, object>
            {
                ["FirstName"] = firstName
            },
            Attachments = new List<SendNotificationAttachment>
            {
                new()
                {
                    FileName = "welcome.txt",
                    MimeType = "text/plain",
                    Content = Convert.ToBase64String(System.Text.Encoding.UTF8.GetBytes("Welcome to ConvergeERP"))
                }
            },
            IsHtml = true,
            Channel = NotificationChannel.Email,
            Priority = NotificationPriority.High
        }, ct);
    }
}

Compatibility Notes

• Attachments is additive and optional.
• During migration, consumers may still support legacy attachments passed through TemplateData["Attachments"].
• If your service does not send file payloads, you can omit Attachments.

Package Metadata

This project is configured with:

• PackageId: ConvergeERP.Shared.Notification
• TargetFramework: net10.0
• PackageReadmeFile: README.md