Skip to main content

Initialize Journey Engine

Endpoint​

/i/journey-engine/init

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

Initializes journey processing with provided runtime data and app user context. This endpoint is intended for system-level initialization flows.

Authentication​

  • No dashboard authentication check is applied at this endpoint.

Permissions​

  • No dashboard permission check is applied at this endpoint.

Request Parameters​

ParameterTypeRequiredDescription
Request bodyObjectYesJSON payload consumed directly by the initializer
dataObjectYesInitialization payload passed to engine
appUserObjectYesApp user context object

Response​

Success Response​

{
  "result": "Journey engine initialized"
}

Response Fields​

FieldTypeDescription
resultStringOperation status

Error Responses​

HTTP StatusResponse
500Runtime/parsing error if body is not valid JSON

Behavior/Processing​

  1. Parses JSON body.
  2. Reads data and appUser.
  3. Calls journey.initialize(data, appUser).
  4. Returns success message.

Database Collections​

This endpoint does not read or write database collections.

Examples​

{
  "data": {
    "key": "[CLY]_session",
    "appId": "123456789",
    "timestamp": 1739239212000
  },
  "appUser": {
    "uid": "user_123",
    "did": "device_456"
  }
}

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions

Last Updated​

2026-02-16