Back to Documentation
Generic HTTPS connector
Connect any customer-hosted HTTPS server to CommsOK and feed email and engagement events through a small, well-defined contract.
When to use it
Reach for the generic HTTPS connector when an off-the-shelf integration doesn't fit your setup.
- Your team wants to obfuscate or aggregate events before they leave your network.
- Your ESP or in-house mailer isn't supported by a native CommsOK integration yet.
- You need to combine events from multiple internal systems into one feed.
How it works
You stand up a small HTTPS server. CommsOK polls it on a schedule and ingests events into the same pipeline as native integrations.
- CommsOK calls your server with a time window and pages through results.
- Each event is validated for shape and dropped if it falls outside the supported taxonomy.
- Suppression decisions are computed from your active ruleset, exactly as with native connectors.
Security
The connector is HTTPS-only and uses an API key you control.
- Plain HTTP is rejected — events carry recipient email addresses.
- CommsOK authenticates with a bearer token you supply at integration setup.
- The token lives in the CommsOK credential vault and is never logged.
What you implement
Two endpoints on your server, both returning JSON.
- GET /v1/info — handshake that reports the protocol and taxonomy version your server emits.
- GET /v1/events — returns events in a requested time window, oldest-first.
- A stable, unique id per event so CommsOK can deduplicate retries.
Want the full wire spec?
For the complete event schema, validation rules, and example payloads, contact us — we'll share the integrator guide and walk you through the setup.
Contact Support