Skip to content

Touch

Port: REST :3100 · gRPC :5100

Records and dispatches all outbound communications — email, in-app notices, web push, and SMS. Every create or send operation may trigger real-world communication. Always confirm recipient, content, and channel before acting.

Collections

CollectionPathPurpose
Emails/touch/emailsOutbound email records
Notices/touch/noticesIn-app notification records
Pushes/touch/pushesWeb push subscription targets
Push Histories/touch/push-historiesPush delivery attempt records
SMSs/touch/smssOutbound SMS records

touch/push-histories has no MCP tools — it is accessible via platform REST only.

touch/emails

Stores outbound email envelope and body data.

Required Create Fields

FieldRequiredTypeDescription
providerEmailProviderNODEMAILER
tostring[]Recipient email addresses
fromstringSender email (display name allowed)
subjectstringEmail subject

Optional Fields

FieldTypeDescription
htmlstringHTML body
textstringPlain text body
cc / bccstring[]Additional recipients
reply_tostring[]Reply-to addresses
datedateScheduled send time
attachmentsMongoId[]Raw special/files IDs — not populatable
smtpobjectSMTP delivery metadata

At least one of html or text must be present.

Special Send Operations (platform REST only)

POST /touch/emails/send

touch/notices

In-app notifications displayed inside client applications.

Required Create Fields

FieldRequiredTypeDescription
typeNoticeTypeINFO, EVENT, ALERT, WARNING, ERROR, SUCCESS, NOTICE, MESSAGE
titlestringNotice title
contentstringNotice body

Optional Fields

FieldTypeDescription
subtitlestringSecondary title
categorystringCustom grouping label
visitedbooleanRead status
thumbnailMongoIdRaw file ID — not populatable
attachmentsMongoId[]Raw file IDs — not populatable
actionsobject[]Action buttons

touch/pushes

Web push subscription targets for browser/device delivery.

Required Create Fields

FieldRequiredTypeDescription
sessionMongoIdSession ID
keysobjectPush subscription keys — write-only, never returned
endpointstringPush endpoint URL
expirationnumberExpiration Unix timestamp

Special Send Operation (platform REST only)

POST /touch/pushes/send

touch/push-histories

Delivery attempt records for push notifications.

No MCP tools — use platform REST to inspect push delivery history.

Population

PathCollection
totouch/pushes

touch/smss

Outbound SMS records.

Required Create Fields

FieldRequiredTypeDescription
providerSmsProviderKAVENEGAR, MELIPAYAMAK
messagestringSMS body
receptorsstring[]Recipient phone numbers (E.164 format)

Optional Fields

FieldTypeDescription
senderstringSender number or line ID
resobjectProvider response metadata

Special Send Operations (platform REST only)

EndpointPurpose
POST /touch/smss/sendDirect SMS send
POST /touch/smss/send/templateTemplate SMS with parameters