> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Ingest a page event

> Segment-compatible `page` call — records a web pageview. Sign the raw body with your tenant ingest secret (`x-orbit-cdp-*` headers) and supply either `userId` or `anonymousId`. The `properties` blob conventionally carries `url`, `path`, `referrer` and `title`; the optional `name` and `category` label the page.



## OpenAPI

````yaml /openapi.yaml post /cdp/v1/{ingest_id}/page
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /cdp/v1/{ingest_id}/page:
    post:
      tags:
        - CDP
      summary: Ingest a page event
      description: >-
        Segment-compatible `page` call — records a web pageview. Sign the raw
        body with your tenant ingest secret (`x-orbit-cdp-*` headers) and supply
        either `userId` or `anonymousId`. The `properties` blob conventionally
        carries `url`, `path`, `referrer` and `title`; the optional `name` and
        `category` label the page.
      parameters:
        - schema:
            type: string
          in: path
          name: ingest_id
          required: true
          description: Public, tenant-bound ingest identifier from your CDP source config.
        - schema:
            type: string
          in: header
          name: x-orbit-cdp-signature
          required: true
          description: >-
            HMAC-SHA256 of the raw request body, keyed by the tenant ingest
            secret.
        - schema:
            type: string
          in: header
          name: x-orbit-cdp-timestamp
          required: true
          description: >-
            Unix-epoch seconds the payload was signed; rejected outside the
            replay window.
        - schema:
            type: string
          in: header
          name: x-orbit-cdp-nonce
          required: true
          description: Unique per-request nonce used to reject replays.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                anonymousId:
                  type: string
                name:
                  type: string
                category:
                  type: string
                properties:
                  type: object
                  additionalProperties: true
                timestamp:
                  type: string
                  format: date-time
                messageId:
                  type: string
            example:
              userId: user_9f2a
              name: Pricing
              properties:
                url: https://example.com/pricing
                path: /pricing
                referrer: https://example.com/
      responses:
        '200':
          description: Pageview accepted and persisted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      received:
                        type: boolean
                      event_id:
                        type: string
                      contact_id:
                        type: string
                        nullable: true
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````