REST Provider Payloads

When user-srv or useractions-srv sends an email or SMS, the call goes to POST /notifications-srv/notifications. notification-srv renders the published template, then comm-prov-srv POSTs the result to your custom provider CommunicationEP.

The table shows the current nested contract — the same shape as the examples on Communication providers:

• service_id, message_id, id
• criteria, senderAddress / senderName / replyAddress, recipientAddresses
• Rendered content plus systemAttributes, customAttributes, contextAttributes
• Query: ack_id equals message_id (not part of the JSON body)

content.content and content.subject are already rendered. Subject and body in the table are short stand-ins — production text comes from your published template.

This table covers notifications sent by user-srv and useractions-srv only (admin create, status change, unregister, welcome, invite, communication-medium change). Custom invite keys such as CRM_INVITE in the developer group use the same envelope as INVITE_USER with a different templateKey. Password reset and MFA login OTPs from verification-srv are not listed here.

Payload reference

Use the search box to filter by channel, template key, or source service. Click View Full Payload for the complete outbound JSON and field notes.

Explore related topics

• Communication providers
• Communication templates
• Send Template-Based Notifications

Need Support?

For any further assistance, feel free to visit our Support Portal.