Developers / API integration

Connect message journeys to real business events

Notify2You's enterprise aggregation service connects business systems with carrier and channel paths through message objects, suggested actions, SMS fallback and webhook-based state handling.

Message object

Make the primary and fallback paths explicit

The message object keeps rich content and SMS fallback separate so both experiences can be reviewed during integration.

  • Supply a traceable business reference
  • Give each suggested action a clear type and target
  • Include only data necessary for the message
  • Keep credentials out of message bodies and webhooks
Integration documentation defines endpoints, authentication, schemas, limits, permissions and capability scope.
message-object-pattern.json
{
  "externalRef": "order_1042",
  "recipient": "+{country}{number}",
  "rcs": {
    "title": "Your parcel arrives today",
    "text": "Estimated 2:20–4:20 PM",
    "actions": [
      { "type": "OPEN_URL", "label": "Track parcel" }
    ]
  },
  "fallback": {
    "channel": "SMS",
    "text": "Parcel due today. Track: {trusted_link}"
  }
}
Integration flow

Define the events before connecting the interface

Put permissions, security, consent and exceptional paths ahead of endpoint wiring.

01

Define the business event

Decide when to send, whom to send to, and when not to send.

02

Design both content paths

Write the RCS card and SMS fallback separately.

03

Establish identity & consent

Confirm sender, recipient consent, opt-out and applicable rules.

04

Implement idempotency

Use stable references and safe retry semantics.

05

Verify webhook handling

Validate signatures and tolerate duplicate or out-of-order events.

06

Test target conditions

Build acceptance cases around target markets, devices and fallback.

Webhook events

Return message activity to the business system

Webhooks carry status changes and user actions through defined event names, signature validation, retry windows and field conventions.

  • Acknowledge quickly, then process asynchronously
  • Deduplicate event IDs and tolerate out-of-order arrival
  • Use external references to join activity to business records
message-webhook.json
{
  "eventId": "evt_1042_01",
  "eventType": "message.action",
  "occurredAt": "2026-08-29T09:41:00Z",
  "data": {
    "externalRef": "order_1042",
    "action": "TRACK_PARCEL"
  }
}

// Route verified actions into the business workflow.
Operational foundations

Ask the right production questions

A production integration coordinates identity, permissions, limits, data handling, monitoring and recovery across the full request lifecycle.

View the integration checklist

Use environment-specific base URLs, controlled credentials and versioned documentation for production API access.

Manage separate base URLs and credentials for development, test and production, with controlled release transitions.

Messages can inform and guide, but payments, identity checks and account changes should happen in an appropriately secured flow.

Discuss the integration

Bring the event model and fallback copy to the technical conversation.

Organize markets, use cases, volume range, consent requirements and preferred system connections.