Skip to main content

Twilio connector — overview

The Twilio connector is Ark's SMS notification connector. It exposes Ark's notification API — send, schedule, cancel, purge, and look up — and delivers messages through Twilio's Messaging API. It keeps a local record of every notification it handles for audit, status lookup, and cancellation.

The Platform is the source of truth for notification content and policy — it resolves templates, applies allow-lists, and passes the connector final, ready-to-send message content. The connector's job is delivery + a local delivery log.

What it does

CapabilityEndpoint
Send or schedule an SMSPOST /v1/notifications
List notificationsGET /v1/notifications
Get one notificationGET /v1/notifications/{id}
Cancel a scheduled SMSDELETE /v1/notifications/{id}
Purge a notification (compliance)POST /v1/notifications/{id}/purge

See endpoints for how to call them and lifecycle for how a notification moves between states.

Shape

  • SMS only. Only the SMS channel is implemented; other channels in the contract are rejected (see the connector notes).
  • DB-backed. Each send is logged to a local notification store; list/get read from that store, not from Twilio. See the architecture's persistence model.
  • Native scheduling. Uses Twilio's scheduled-message feature; scheduled sends must be 5 min–35 days out (lifecycle).
You want…Doc
How to call the APIendpoints (non-dev)
How a notification progresseslifecycle (non-dev)
How it's built and per-endpoint internalsarchitecture (dev)
How to build, run, test, and regenerate clientsdevelopment (dev)
Quirks, gaps, and provider caveatsnotes (dev)

The formal request/response contract is the OpenAPI specification (the Notification API, openapi/source/connector/notifications/notifications.yml); this doc set does not restate it.