Documentation
API reference

Capture Journey events

POST
/api/v1/journeys/{journeyId}/capture

Captures an idempotent batch after current authorization. Optional revisionId pins the session to the displayed revision, including one whose configuration has been pruned. Conflicting or cross-Journey revision identifiers are rejected.

Authorization

publishableKey
AuthorizationBearer <token>

A brand-scoped FounderHQ publishable key.

In: header

Path Parameters

journeyId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/journeys/string/capture" \  -H "Content-Type: application/json" \  -d '{    "clientSessionId": "string",    "events": [      {        "id": "string",        "type": "session_start"      }    ]  }'
{  "accepted": 0,  "ok": true,  "sessionId": "string"}

AI agent or LLM? Read this page as markdown