Skip to main content

​
Public Web Surface

Most of the Devotel Orbit API answers only to a bearer deal-credential — an API key or JWT. A small set of routes is deliberately public: a customer’s email client fetching an engagement pixel, a shopper’s browser following a short link, or your identity provider completing a SAML handshake cannot carry an Orbit credential. This section collects those public endpoints and explains what each does, who calls it, and what gets logged when it fires. Authenticated parts of the platform call these same routes with your API key or session token; the prefixes below are simply reachable without one.

​
Engagement tracking

Messages sent from Orbit include two pixel endpoints for engagement attribution. Each logs an event against the message or goal it was embedded in, then returns a 1×1 transparent GIF. Deploy the pixel that matches your send path (email opens for lifecycle email, goal pixels for funnel attribution). Because email clients and link scanners prefetch aggressively, treat opens as a directional signal, not a hard fact — the same image is fetched by bots, proxies, and inbox previews. These endpoints power link-based campaigns. Both redirect with a 302 to the configured destination and log a click event when the reference resolves. Signature-bearing variants (/r/{sig}/{target}) are the routes you hand to partners or embed in third-party pages — unsigned guessing simply returns 404.

​
SAML single sign-on

The /auth/saml/{orgSlug} namespace is the service-provider endpoint for dashboard SSO, configured per organization. Your identity provider (Okta, Entra ID, OneLogin, JumpCloud) posts directly to these, so they must not require an Orbit credential. Set the full flow up in the SAML SSO enrollment guide. The identity-federation concept page (SAML + SCIM) covers the trusts and session mapping behind it.

​
SCIM provisioning

The /scim/v2/{orgSlug} namespace exposes the user/group/role provisioning surface your IdP drives with its bearer token — the SCIM base URL you paste into Okta or Entra. Provision in the SCIM provisioning guide; the same concept page linked above covers the mapping of IdP groups onto dashboard roles.