Skip to main content

Initialize Journey Engine

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/journey-engine/init

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

Examples

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

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

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

Database Collections

This endpoint does not read or write database collections.