Skip to main content

Send a notification to a party

POST 
/v1/notifications

Connector Service Endpoint

This endpoint is used by the Ark Platform to send notifications through external delivery services.

Important: This is an internal connector API. Client applications should use the Platform Notification APIs for all notification operations including status checking and history retrieval.

Architecture:

  • The Platform is the source of truth for all notification data and status
  • Connectors handle delivery through external services (SMS providers, Email providers, Push services)
  • Status updates are propagated back to the Platform via events, not polling
  • Connectors maintain their own delivery logs for debugging and audit purposes

Authentication & Context:

  • Requires valid service-to-service authentication
  • Party and user identifiers are passed from the Platform

Message Processing:

  • Message content is already processed by the Platform (templates resolved, variables substituted)
  • Connectors receive final message content ready for delivery
  • Business rules and allow-list validation are handled by the Platform

Channel Specific Requirements:

  • SMS: Phone numbers in E.164 format, delivered via the SMS provider
  • EMAIL: Valid email addresses, delivered via configured SMTP provider
  • DEVICE: Valid device tokens, delivered via the push notification service

Request​

Responses​

Notification sent successfully

Last updated on