This API enables custom event transformation logic for your organization. You can only have one active configuration per entity at any given time.

👍
Note
For detailed API documentation and interactive testing, see API overview and Make your first API call.

Prerequisites

Authentication: Basic or OAuth
Access: Default access group

Resource information

Property	Value
URI	`/api_gateway/cortex/v1/neo-config`
Method	POST
Pagination	N/A
Rate limit	Default
Batch	N/A

API endpoint example

POST https://eu.api.capillarytech.com/api_gateway/cortex/v1/neo-config

Request body

{
  "orgId": 100737,
  "entityType": "TRANSACTION",
  "transformEndpoint": "/transform/transaction/custom",
  "active": true
}

{
  "orgId": 100737,
  "entityType": "CUSTOMER",
  "transformEndpoint": "/transform/customer/custom",
  "active": true
}

Request body parameters

Parameter	Type	Description
orgId*	long	Your organization ID.
entityType*	string	Entity to configure. Supported: `CUSTOMER`, `TRANSACTION`.
transformEndpoint*	string	Path of the NEO service endpoint for transformations (e.g., `/transform/transaction/custom`).
active	boolean	Whether this configuration is active. Use `false` to deactivate an existing config by re-submitting with `active: false`.

Response body example

{
  "data": {
    "orgId": 100737,
    "entityType": "TRANSACTION",
    "transformEndpoint": "/transform/transaction/custom",
    "active": true,
    "auditInfo": {
      "createdOn": "2025-04-23T06:59:56.411+00:00",
      "createdBy": 75155282,
      "lastUpdatedOn": "2025-04-23T07:06:33.947+00:00",
      "lastUpdatedBy": 75155282
    }
  },
  "errors": []
}

Response parameters

Parameter	Type	Description
`orgId`	long	The organization ID (`100737`).
`entityType`	string	Entity configured (`CUSTOMER` or `TRANSACTION`).
`transformEndpoint`	string	Configured transformation endpoint path.
`active`	boolean	Whether the configuration is active.
`auditInfo.createdOn`	date	Creation timestamp (ISO 8601).
`auditInfo.createdBy`	long	User ID who created the config.
`auditInfo.lastUpdatedOn`	date	Last update timestamp (ISO 8601).
`auditInfo.lastUpdatedBy`	long	User ID who last updated the config.
`errors`	array	List of errors, if any (empty on success).

API error codes

Error code	Description
`400 BAD_REQUEST`	The request body is invalid JSON<br>- Required fields are missing<br>- The request body fails validation<br>- Constraint violations occur
`401 UNAUTHORIZED`	Authentication is missing or invalid<br>- The auth token is not provided
`403 FORBIDDEN`	The authenticated user doesn't have permission to create configurations
`500 INTERNAL_SERVER_ERROR`	Unexpected server errors occur<br>- Database operations fail<br>- Other runtime exceptions occur