{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Events API

Events endpoints exposed by the Devotel CPaaS API Base path: /api/v1/events Endpoint count: 9

Track events power more than campaigns and journeys. They feed the Customer-360 workspace timeline, where one snapshot call aggregates a contact’s events, conversations, voice calls, tickets, and more into a single workspace view.

Worked sequences

The four operations below are a complete walk-through of the Events surface, in the order an integration typically uses them: page through history, look up a single event, tail the live stream, and publish your own events. Every response below is a worked copy of the wire shape, and the Node examples route through the SDK’s orbit.request() helper.

List event history — GET /events

Page through the tenant’s recent-event history newest-first. The first request omits cursor; each page’s meta.pagination.cursor feeds the next request while has_more is true. Step 1 — first page

curl -X GET "https://api.orbit.devotel.io/api/v1/events/?limit=3" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY! })

const page1 = await orbit.request('GET', '/events/?limit=3')

Response (first page)

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Step 2 — page forward while has_more is true

Node.js

const page2 = await orbit.request(
  'GET',
  `/events/?limit=3&cursor=${encodeURIComponent(page1.meta.pagination.cursor)}`,
)

Send the cursor verbatim — it is the id of the last event from the prior page (<ms>-<seq> form). When has_more comes back false, history is exhausted.

Get event details — GET /events/:id

Fetch one event by its id — either the canonical stream id from a list page (1755008400000-0) or a legacy publisher-minted evt_* id. Both resolve against the same history window. Request

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events/1755008400000-0" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/1755008400000-0', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events/1755008400000-0", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events/1755008400000-0", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/1755008400000-0')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/1755008400000-0');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

Response

{
  "data": {
    "id": "1755008400000-0",
    "type": "message.delivered",
    "ts": 1755008400000,
    "data": {
      "message_id": "msg_9f2a1c4e",
      "channel": "sms",
      "to": "+1415555****",
      "from": "+1415000****",
      "status": "delivered",
      "delivered_at": "2026-08-12T14:20:00.000Z"
    }
  },
  "meta": {
    "request_id": "req_evt_get",
    "timestamp": "2026-08-12T14:31:00.000Z"
  }
}

An id outside the retained history window returns a 404 with the NOT_FOUND error envelope.

Live tail — GET /events/stream (SSE)

For a live dashboard, open a Server-Sent Events connection instead of polling. The stream replays anything buffered after your Last-Event-ID (or ?lastEventId=), then tails events as they publish. A 30-second : heartbeat comment frame keeps the connection open between events. curl (server-side, secret API key)

curl -N \
  -H "Accept: text/event-stream" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  "https://api.orbit.devotel.io/api/v1/events/stream?types=message.delivered,message.failed"

Browser EventSource (Clerk session cookie)

const es = new EventSource(
  'https://api.orbit.devotel.io/api/v1/events/stream?types=message.delivered',
  { withCredentials: true },
)

es.addEventListener('message.delivered', (e) => {
  const event = JSON.parse(e.data)
  console.log(e.lastEventId, event.data.status, event.data.message_id)
  // persist e.lastEventId — pass it back as ?lastEventId= on reconnect
})

Non-browser Node clients can keep a durable cursor on the ?lastEventId= query parameter (EventSource re-sends it as the Last-Event-ID header automatically). Sample stream frames

: heartbeat

id: 1755008400000-0
event: message.delivered
data: {"id":"1755008400000-0","type":"message.delivered","ts":1755008400000,"data":{"message_id":"msg_9f2a1c4e","channel":"sms","status":"delivered"}}

id: 1755008461000-0
event: message.failed
data: {"id":"1755008461000-0","type":"message.failed","ts":1755008461000,"data":{"message_id":"msg_7b4e9d3c","channel":"sms","status":"failed","error_code":"CARRIER_REJECTED"}}

Each frame is id:, event:, and data: separated by a blank line. On reconnect, re-send the last id you saw and the replay pass fills the gap before the live tail resumes. ?types= narrows both the replay and the live tail to the comma-separated event types.

Publish a tracked event — POST /events/track

Record a domain event for a contact — Order Placed, Subscription Renewed, Trial Converted — to drive lifecycle campaigns, journey triggers, and the customer-360 timeline. The body is validated against the same per-event contract the schema registry publishes; GET /events/schema-registry returns that catalog (dialect, per-type JSON Schema, example payload, and a drift-detecting fingerprint) so you can pin the shape client-side. Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/events/track/" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "event": "Order Placed",
  "contact_email": "ana@example.com",
  "properties": {
    "order_id": "ord_1138",
    "total": 49,
    "currency": "USD"
  },
  "message_id": "msg_client_42",
  "timestamp": "2026-08-12T14:22:18.000Z"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/track/', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "event": "Order Placed",
  "contact_email": "ana@example.com",
  "properties": {
    "order_id": "ord_1138",
    "total": 49,
    "currency": "USD"
  },
  "message_id": "msg_client_42",
  "timestamp": "2026-08-12T14:22:18.000Z"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/events/track/", headers=headers, json={
  "event": "Order Placed",
  "contact_email": "ana@example.com",
  "properties": {
    "order_id": "ord_1138",
    "total": 49,
    "currency": "USD"
  },
  "message_id": "msg_client_42",
  "timestamp": "2026-08-12T14:22:18.000Z"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/events/track/", bytes.NewBuffer([]byte(`{
  "event": "Order Placed",
  "contact_email": "ana@example.com",
  "properties": {
    "order_id": "ord_1138",
    "total": 49,
    "currency": "USD"
  },
  "message_id": "msg_client_42",
  "timestamp": "2026-08-12T14:22:18.000Z"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/track/')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "event": "Order Placed",
  "contact_email": "ana@example.com",
  "properties": {
    "order_id": "ord_1138",
    "total": 49,
    "currency": "USD"
  },
  "message_id": "msg_client_42",
  "timestamp": "2026-08-12T14:22:18.000Z"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/track/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "event": "Order Placed",
  "contact_email": "ana@example.com",
  "properties": {
    "order_id": "ord_1138",
    "total": 49,
    "currency": "USD"
  },
  "message_id": "msg_client_42",
  "timestamp": "2026-08-12T14:22:18.000Z"
}
JSON);
echo curl_exec($ch);

Response

{
  "data": {
    "received": true,
    "event_id": "evt_9c2d4e6f8a0b1c3d4e5f6a",
    "contact_id": "con_4f2a8c1d9e3b",
    "deduped": false
  },
  "meta": {
    "request_id": "req_evt_track",
    "timestamp": "2026-08-12T14:22:19.000Z"
  }
}

event is required; contact_email or contact_phone identify the contact (unmatched events are still recorded and stitch later). properties carries event attributes, message_id is a client-side dedup key, and timestamp is the client event time — the server’s receipt time remains the canonical sort key. A retry with the same Idempotency-Key or message_id returns deduped: true without writing a second row. The registry is fetched with a plain GET:

curl -X GET "https://api.orbit.devotel.io/api/v1/events/schema-registry" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const registry = await orbit.request('GET', '/events/schema-registry')

Poll data.catalog_version to detect any change to the platform event contract cheaply, then diff each schema’s fingerprint to see which event types moved.

List event history

GET /api/v1/events

Cursor-paginated history of recent platform events for the authenticated tenant. Returns the standard paginated envelope; pass cursor from a prior page’s meta.pagination.cursor (an event id) to page forward. For a live tail use GET /events/stream (SSE) instead of polling.

string

Opaque pagination cursor from a prior page’s meta.pagination.cursor (an event id). Omit for the first page.

integer

Page size (1–200, default 25).

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Get event details

GET /api/v1/events/{id}

Fetch a single platform event by its id from the tenant’s recent-event history. The id may be either the canonical stream id (<ms>-<seq>) or a publisher-minted evt_* id carried in the payload. Returns 404 when no event with the given id is within the current history window for the tenant.

string

required

Event id — the canonical stream id (<ms>-<seq>) or a legacy evt_* payload id.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Consume events for a consumer group

GET /api/v1/events/consume

Poll the next batch of platform events for a managed consumer group. Reads in order from the group’s server-side committed offset and does NOT advance it — commit meta.next_offset via POST /events/consume/commit only after you have durably processed the batch. This is at-least-once: a crash before commit re-delivers the same batch, so deduplicate on each event’s id. A group that has never committed starts at the beginning of the retained window.

string

required

Consumer-group name (1–128 chars of letters, digits, ._:-, starting alphanumeric). Offsets are tracked per group, so independent consumers use distinct groups.

integer

Maximum events to return (1–500, default 100).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events/consume" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/consume', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events/consume", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events/consume", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/consume')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/consume');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

List consumer groups

GET /api/v1/events/consumer-groups

List the tenant’s managed event-stream consumer groups with each group’s committed offset and approximate lag (retained events after the committed offset).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events/consumer-groups" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/consumer-groups', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events/consumer-groups", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events/consumer-groups", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/consumer-groups')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/consumer-groups');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Get the versioned event schema registry

GET /api/v1/events/schema-registry

Machine-readable, versioned catalog of every event type the firehose (GET /events/stream, GET /events/consume) and webhooks emit. Each entry carries a Draft-07 envelope JSON Schema (with the type literal pinned), a realistic example payload, and a deterministic fingerprint. Poll the top-level catalog_version to learn — in one field — whether the platform event contract changed at all, then diff each entry’s fingerprint to see which event schemas moved, so a data-warehouse or SIEM consumer can pin schemas and regenerate types only when they actually drift. The catalog is identical for every tenant.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events/schema-registry" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/schema-registry', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events/schema-registry", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events/schema-registry", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/schema-registry')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/schema-registry');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

GET /api/v1/events/stream

Server-Sent Events stream of platform events for the tenant (message, call, and other resource lifecycle events) so live dashboards can be built without polling GET /events or running a webhook receiver. Authenticate a browser EventSource with the Clerk session cookie (withCredentials) or ?token=; server-side callers pass the secret API key. Optional ?types= narrows the event types delivered; reconnect with the Last-Event-ID header (or ?lastEventId=) to replay buffered events and resume without gaps.

string

Comma-separated allowlist of event types to deliver (e.g. message.delivered,message.failed). Applied to both the Last-Event-ID replay pass and the live tail. Omit to receive all event types for the tenant.

string

Resume cursor — the id of the last event the client received. Replays buffered events newer than this id before live streaming.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/events/stream" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/stream', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/events/stream", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/events/stream", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/stream')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/stream');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Commit a consumer-group offset

POST /api/v1/events/consume/commit

Advance a consumer group’s committed offset after you have processed a batch. Monotonic: a stale, duplicated, or out-of-order commit never rewinds the offset and returns applied: false. To move backwards (replay/backfill) use POST /events/consume/seek.

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

string

required

Consumer-group name.

string

required

The offset to commit — a stream id (<ms>-<seq>, typically meta.next_offset from a consume batch) or 0.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/events/consume/commit" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "group": "string",
  "offset": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/consume/commit', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "group": "string",
  "offset": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/events/consume/commit", headers=headers, json={
  "group": "string",
  "offset": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/events/consume/commit", bytes.NewBuffer([]byte(`{
  "group": "string",
  "offset": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/consume/commit')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "group": "string",
  "offset": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/consume/commit');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "group": "string",
  "offset": "string"
}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Seek a consumer group (replay / backfill)

POST /api/v1/events/consume/seek

Reset a consumer group’s offset to replay or backfill events. Provide exactly one of to (beginning = replay the full retained window, end = skip everything currently retained and consume only new events) or offset (an explicit stream id / 0). Unlike commit, seek may move the offset backwards.

string

string (enum: true|false)

string

required

Consumer-group name.

string (enum: beginning|end)

Relative seek target. Mutually exclusive with offset.

string

Explicit offset (stream id or 0). Mutually exclusive with to.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/events/consume/seek" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "group": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/consume/seek', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "group": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/events/consume/seek", headers=headers, json={
  "group": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/events/consume/seek", bytes.NewBuffer([]byte(`{
  "group": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/consume/seek')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "group": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/consume/seek');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "group": "string"
}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

Track a product event

POST /api/v1/events/track

Records a domain event for a contact in your workspace, such as Order Placed, Subscription Renewed, or Trial Converted, to drive lifecycle campaigns, journey triggers, and the customer-360 timeline. Authenticate with your secret API key via the X-API-Key header. The JSON body requires event (the event name) and may identify the contact with contact_email or contact_phone; events with no matching contact are still recorded and can be stitched to a contact later. Optionally pass properties (an object of event attributes), message_id (a client-supplied de-duplication key), and timestamp (an ISO-8601 client event time, while the server receipt time stays the canonical sort key). Send an Idempotency-Key header to make retries safe. Returns { received, event_id, contact_id, deduped }.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/events/track" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/events/track', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/events/track", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/events/track", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/events/track')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/events/track');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": [
    {
      "id": "1755008400000-0",
      "type": "message.delivered",
      "ts": 1755008400000,
      "data": {
        "message_id": "msg_9f2a1c4e",
        "channel": "sms",
        "to": "+1415555****",
        "from": "+1415000****",
        "status": "delivered",
        "delivered_at": "2026-08-12T14:20:00.000Z"
      }
    },
    {
      "id": "1755008300000-0",
      "type": "call.completed",
      "ts": 1755008300000,
      "data": {
        "call_id": "call_3f7b1d2c",
        "direction": "outbound",
        "duration_seconds": 184,
        "status": "completed"
      }
    },
    {
      "id": "1755008200000-0",
      "type": "message.failed",
      "ts": 1755008200000,
      "data": {
        "message_id": "msg_8c3d2b1a",
        "channel": "whatsapp",
        "to": "+1415566****",
        "status": "failed",
        "error_code": "CARRIER_REJECTED"
      }
    }
  ],
  "meta": {
    "request_id": "req_evt_page1",
    "timestamp": "2026-08-12T14:30:00.000Z",
    "pagination": {
      "cursor": "1755008200000-0",
      "has_more": true,
      "total": 3
    }
  }
}

API Reference

All Endpoints

Events API

Events API

Worked sequences

List event history — GET /events

Get event details — GET /events/:id

Live tail — GET /events/stream (SSE)

Publish a tracked event — POST /events/track

List event history

Get event details

Consume events for a consumer group

List consumer groups

Get the versioned event schema registry

Commit a consumer-group offset

Seek a consumer group (replay / backfill)

Track a product event

​Events API

​Worked sequences

​List event history — GET /events

​Get event details — GET /events/:id

​Live tail — GET /events/stream (SSE)

​Publish a tracked event — POST /events/track

​List event history

​Get event details

​Consume events for a consumer group

​List consumer groups

​Get the versioned event schema registry

​Subscribe to the real-time platform event stream (SSE)

​Commit a consumer-group offset

​Seek a consumer group (replay / backfill)

​Track a product event

Events API

Worked sequences

List event history — GET /events

Get event details — GET /events/:id

Live tail — GET /events/stream (SSE)

Publish a tracked event — POST /events/track

List event history

Get event details

Consume events for a consumer group

List consumer groups

Get the versioned event schema registry

Subscribe to the real-time platform event stream (SSE)

Commit a consumer-group offset

Seek a consumer group (replay / backfill)

Track a product event