Build · Platform API

Platform API reference

Everything the console does, from your own code: integrations, flows, runs, connections, triggers, reconciliation, approvals and MCP. Version 2026-10-01.

OpenAPI 3.1 Get started

Overview

The Nexra platform API lets your own software do what the Nexra console does: build and run integrations, follow every run, manage connections, triggers and reconciliations, receive signed events and answer approvals.

Authentication. Send a Nexra access token as Authorization: Bearer <token> and the workspace to act in as X-Workspace-Id: <workspaceId>. Sign in with the Nexra CLI (nexra auth login) to get a token; it carries your own role, so the API can do exactly what you can do in the console. Public operations need no token.

Errors. Every error has the same JSON shape: error, message, statusCode, requestId and path, plus a stable code where one exists. Quote the requestId (also sent as the X-Request-ID header) when you contact support.

Lists. List operations return the newest items first, as a plain array capped at a documented size. Operations that page with a cursor return { items, nextCursor }; pass nextCursor back as cursor until it is null.

Retries. Requests that start work (for example starting a run) take an idempotencyKey. Sending the same key again returns the first result instead of starting the work twice, so it is safe to retry after a network error.

Versioning. This description is version 2026-10-01. Adding an operation or an optional field is not a breaking change; a breaking change gets a new dated version.

The TypeScript and Python examples use the Nexra SDKs. Contact us at contact@usenexra.ai for package access. The cURL examples work today.

Errors

Error

{
  "error": "request_failed",
  "message": "A bounded execution idempotency key is required.",
  "statusCode": 400,
  "requestId": "1f0c2a4e-6b1d-4c39-9d0f-2f8a8e1f6b7a",
  "path": "/api/console/connect/flows/cmflow01orders/executions"
}

400

The request was not valid. message says what to change.

401

The access token is missing, expired or revoked.

403

Your role in this workspace does not allow this action, or the workspace is not yours.

404

Nothing with that id exists in this workspace.

409

The request conflicts with the current state, for example a record that was already decided.

413

The request body is larger than this endpoint accepts.

429

Too many requests. Wait for the number of seconds in Retry-After, then try again.

500

Nexra could not complete the request. It is safe to retry with the same idempotency key.

503

The service this needs is switched off or busy for your workspace. message says which; try again later.

Integrations

An integration groups the flows that connect two or more systems for one business purpose.

GET/api/console/connect/integrations

List integrations

Integrations in the workspace, most recently changed first, with their flows and lifecycle. Archived and deleted ones are left out.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/integrations"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations

Create an integration

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
namerequired	string
projectIdrequired	string	A project in this workspace.
slug	string	Defaults to a slug of the name. Must be unique.
description	string
businessOwnerUserId	string \| null	Workspace member who owns the business outcome. Send `null` to clear.
technicalOwnerUserId	string \| null

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations", {
    body: {
      "name": "string",
      "projectId": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/integrations/{integrationId}

Get an integration

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/integrations/{integrationId}", {
    params: { path: { integrationId: "integration_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/integrations/{integrationId}

Update an integration

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Request body · application/json

Request body
Field	Type	Description
name	string
description	string	An empty string clears it.
ownerUserId	string \| null	Same as `businessOwnerUserId`.
businessOwnerUserId	string \| null	Workspace member who owns the business outcome. Send `null` to clear.
technicalOwnerUserId	string \| null

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/integrations/{integrationId}", {
    params: { path: { integrationId: "integration_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations/{integrationId}/archive

Archive an integration

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/archive", {
    params: { path: { integrationId: "integration_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/integrations/{integrationId}/export

Export an integration

A description of the integration for use from other tools: its flows, operations, mappings and how to call it through MCP. It never contains credentials.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/integrations/{integrationId}/export", {
    params: { path: { integrationId: "integration_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

Flows

A flow moves records from a source to a destination. Flows have versions; one version is published at a time.

POST/api/console/connect/integrations/{integrationId}/flows

Create a flow

Creates a flow with a first draft version.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Request body · application/json

Request body
Field	Type	Description
namerequired	string
triggerType	"manual" \| "schedule"
environment	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
slug	string
description	string
versionLabel	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/flows", {
    params: { path: { integrationId: "integration_id" } },
    body: {
      "name": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string
activeVersionIdrequired	string \| null	The published version runs use.
ownerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
versions	array of object
lifecycle	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}

Get a flow

The flow with its versions, schedules, lifecycle and read progress.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string
activeVersionIdrequired	string \| null	The published version runs use.
ownerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
versions	array of object
lifecycle	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/flows/{flowId}

Update a flow

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
name	string
description	string
ownerUserId	string \| null	A workspace member. Send `null` to clear.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/flows/{flowId}", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string
activeVersionIdrequired	string \| null	The published version runs use.
ownerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
versions	array of object
lifecycle	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/versions

List a flow's versions

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/versions", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
versionNumberrequired	integer
versionLabelrequired	string \| null
statusrequired	string
triggerTyperequired	string
validationStatusrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
publishedAtrequired	string \| null	ISO 8601 date and time.
sourceVersionIdrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/versions

Create a flow version

A new draft version, optionally copied from an existing one.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
fromVersionId	string	Copy this version's steps and mappings.
environment	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
triggerType	"manual" \| "schedule"
versionLabel	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/versions", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
versionNumberrequired	integer
versionLabelrequired	string \| null
statusrequired	string
triggerTyperequired	string
validationStatusrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
publishedAtrequired	string \| null	ISO 8601 date and time.
sourceVersionIdrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/versions/{versionId}

Get a flow version

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/versions/{versionId}", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
versionNumberrequired	integer
versionLabelrequired	string \| null
statusrequired	string
triggerTyperequired	string
validationStatusrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
publishedAtrequired	string \| null	ISO 8601 date and time.
sourceVersionIdrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/validate

Check a flow version

Checks the version can run and lists any problems. Defaults to the latest version.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
versionId	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/validate", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
validrequired	boolean
checksumrequired	string \| null
issuesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/publish

Publish a flow version

Makes the version the one runs use. Answers 400 with issues when the version has problems.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
versionId	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/publish", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
flowIdrequired	string
versionIdrequired	string
checksumrequired	string
statusrequired	"published"

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/versions/{versionId}/definition

Get a flow definition

The whole flow as one JSON definition: trigger, steps, connections and mappings.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/versions/{versionId}/definition", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
versionIdrequired	string
statusrequired	string
editablerequired	boolean
builtWithrequired	string
definitionrequired	object \| null
validationStatusrequired	string \| null
issuesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PUT/api/console/connect/flows/{flowId}/versions/{versionId}/definition

Save a flow definition

Replaces a draft version's definition. Published versions cannot change; create a new version instead.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Request body · application/json

Request body
Field	Type	Description
definitionrequired	object	A flow definition. `trigger.kind` is `manual`, `schedule` or `webhook`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PUT("/api/console/connect/flows/{flowId}/versions/{versionId}/definition", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
    body: {
      "definition": {}
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
versionIdrequired	string
savedrequired	true
validationrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/versions/{versionId}/definition/validate

Check a flow definition without saving

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Request body · application/json

Request body
Field	Type	Description
definitionrequired	object	A flow definition.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/versions/{versionId}/definition/validate", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
    body: {
      "definition": {}
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
validrequired	boolean
issuesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/versions/{versionId}/go-live

Check go-live readiness

Whether the version can go live, what blocks it and who needs to approve.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/versions/{versionId}/go-live", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
versionIdrequired	string
publishedrequired	boolean
canGoLiverequired	boolean
blockersrequired	array of object
approvalrequired	object
requestrequired	object \| null
liverequired	object \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/versions/{versionId}/promote

Request go-live

Copies a tested version to live and asks for approval where the workspace needs it. Answers 409 with a code when the version is not ready, for example sandbox_test_required.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Request body · application/json

Request body
Field	Type	Description
environmentId	string
runMode	"always_on" \| "supervised"	How the flow runs once Live. Applied when the go-live is activated.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/versions/{versionId}/promote", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
flowIdrequired	string
sourceVersionIdrequired	string
productionVersionIdrequired	string
revisionrequired	object
approvalrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/run-mode

Get how a flow runs

Test or Live, and once Live: always_on (runs unattended within the workspace's rules) or supervised (every Live write waits for a person's approval). Includes clean Live runs in a row and, for a Supervised flow, a suggestion to move to Always on (never applied automatically).

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/run-mode", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
targetrequired	"test" \| "live"
runModerequired	"always_on" \| "supervised"
runModeChosenrequired	boolean
changedAtrequired	string \| null
liveSincerequired	string \| null
cleanRunsrequired	integer
suggestionrequired	object \| null
resumablerequired	object \| null
pendingGoLiverequired	object \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PUT/api/console/connect/flows/{flowId}/run-mode

Change how a flow runs

Workspace owners and admins only. Recorded in the audit log.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
runModerequired	"always_on" \| "supervised"
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PUT("/api/console/connect/flows/{flowId}/run-mode", {
    params: { path: { flowId: "flow_id" } },
    body: {
      "runMode": "always_on"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
targetrequired	"test" \| "live"
runModerequired	"always_on" \| "supervised"
runModeChosenrequired	boolean
changedAtrequired	string \| null
liveSincerequired	string \| null
cleanRunsrequired	integer
suggestionrequired	object \| null
resumablerequired	object \| null
pendingGoLiverequired	object \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/switch-to-test

Switch a flow back to Test

Immediate: the Live copy stops and Live runs that have not started are cancelled; runs already working finish. Owners, admins and Connect operators. Recorded in the audit log.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/switch-to-test", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
flowIdrequired	string
targetrequired	"test" \| "live"
runModerequired	"always_on" \| "supervised"
runModeChosenrequired	boolean
changedAtrequired	string \| null
liveSincerequired	string \| null
cleanRunsrequired	integer
suggestionrequired	object \| null
resumablerequired	object \| null
pendingGoLiverequired	object \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/take-live-again

Take a flow live again

For a flow switched back to Test with no change since: the go-live checks run again, then the same approved Live copy is switched back on with the chosen run mode. Answers 409 go_live_required when the flow changed; request a new go-live instead.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
runModerequired	"always_on" \| "supervised"

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/take-live-again", {
    params: { path: { flowId: "flow_id" } },
    body: {
      "runMode": "always_on"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
flowIdrequired	string
targetrequired	"test" \| "live"
runModerequired	"always_on" \| "supervised"
runModeChosenrequired	boolean
changedAtrequired	string \| null
liveSincerequired	string \| null
cleanRunsrequired	integer
suggestionrequired	object \| null
resumablerequired	object \| null
pendingGoLiverequired	object \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/go-live

Get a flow's go-live overview

Where the flow stands (test, live or live_with_changes: Live, with a tested change or a draft waiting), what the next go-live changes compared with the Live version (steps, field matching, rules, apps, schedule) in plain sentences, and who may take it live.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/go-live", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
staterequired	"test" \| "live" \| "live_with_changes"
changesrequired	object \| null
liverequired	object \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/versions/{versionId}/go-live/reuse-connection

Reuse a live connection for go-live

Uses a live connection the workspace already has for one app of the flow, instead of entering that app's live key again. Owners, admins and Connect operators. Recorded in the audit log. Answers with the go-live readiness.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
versionId (path)required	string	The version id.

Request body · application/json

Request body
Field	Type	Description
sandboxConnectionIdrequired	string
liveConnectionIdrequired	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/versions/{versionId}/go-live/reuse-connection", {
    params: { path: { flowId: "flow_id", versionId: "version_id" } },
    body: {
      "sandboxConnectionId": "string",
      "liveConnectionId": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
flowIdrequired	string
canGoLiverequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/live-versions

List a flow's live versions

Every version of the flow that has been Live, newest first, with who approved it and whether it can be put back live.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/live-versions", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
flowIdrequired	string
itemsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/live-versions/{revisionId}/rollback

Put an earlier live version back

Immediate: the earlier version, approved when it first went live, replaces the Live one; the replaced version is kept. The run mode stays as it is. Owners, admins and Connect operators. Recorded in the audit log.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
revisionId (path)required	string	The revision id.

Request body · application/json

Request body
Field	Type	Description
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/live-versions/{revisionId}/rollback", {
    params: { path: { flowId: "flow_id", revisionId: "revision_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
flowIdrequired	string
itemsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/read-progress

Get read progress

For flows that read only new records: how far each source has been read.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/read-progress", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
stepKeyrequired	string
statusrequired	string
readUpTo	object
needsAttentionrequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/read-progress/reset

Reset read progress

The next run reads from the start again. Live flows need a deployment approver.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
confirmrequired	true
stepKey	string
environment	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/read-progress/reset", {
    params: { path: { flowId: "flow_id" } },
    body: {
      "confirm": true
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
correlationIdrequired	string
readProgressrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

Runs

A run (an execution) is one pass of a published flow. Start runs, follow their progress and inspect each record.

POST/api/console/connect/flows/{flowId}/executions

Start a run

Starts a run of the flow's published version. Retrying with the same idempotencyKey returns the first run (with replayed: true) instead of starting another.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
idempotencyKeyrequired	string	8 to 160 characters of letters, digits and `. _ : -`. Sending the same key again returns the first result instead of repeating the work.
correlationIdrequired	string	Your own reference for tracing this request across systems (8 to 160 characters).
triggerType	"manual" \| "schedule" \| "retry"
triggerReference	string	Your own reference for what started the run.
inputId	string	An uploaded input (`POST /flows/{flowId}/inputs`). Required for flows that read an uploaded file, refused otherwise.
endUserId	string	Run for one of your customers (an end user). Their own connections replace the app connections they connected through. Refused when they have not connected an app the flow needs.
externalUserId	string	Your own id for the end user, instead of `endUserId`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/executions", {
    params: { path: { flowId: "flow_id" } },
    body: {
      "environment": "sandbox",
      "idempotencyKey": "run-2026-10-01-orders-0001",
      "correlationId": "erp-batch-20261001-0001"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
flowIdrequired	string
flowVersionIdrequired	string
triggerTyperequired	string
triggerReferencerequired	string \| null
statusrequired	string	For example `queued`, `running`, `succeeded`, `partially_succeeded`, `failed` or `cancelled`.
correlationIdrequired	string
idempotencyKeyrequired	string
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
durationMsrequired	integer \| null
recordsReceivedrequired	integer
recordsProcessedrequired	integer
recordsSucceededrequired	integer
recordsFailedrequired	integer
recordsSkippedrequired	integer
retryCountrequired	integer
deadlineAtrequired	string \| null	ISO 8601 date and time.
endUserId	string \| null	The end user (your customer) this run acted for, when it was started for one.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
replayed	boolean	True when this answer is the run first started with the same idempotency key.
selfClearing	object \| null	For runs with failed records: whether they still need a person, are being retried automatically, or were resolved automatically (by a retry or a later run).

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions

List runs

Runs in the workspace, newest first.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (query)	string	Only runs of this flow.
status (query)	string	Only runs with this status, for example `failed`.
endUserId (query)	string	Only runs for this end user.
pageSize (query)	integer	How many to return: 1 to 100, default 50.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
flowIdrequired	string
flowVersionIdrequired	string
triggerTyperequired	string
triggerReferencerequired	string \| null
statusrequired	string	For example `queued`, `running`, `succeeded`, `partially_succeeded`, `failed` or `cancelled`.
correlationIdrequired	string
idempotencyKeyrequired	string
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
durationMsrequired	integer \| null
recordsReceivedrequired	integer
recordsProcessedrequired	integer
recordsSucceededrequired	integer
recordsFailedrequired	integer
recordsSkippedrequired	integer
retryCountrequired	integer
deadlineAtrequired	string \| null	ISO 8601 date and time.
endUserId	string \| null	The end user (your customer) this run acted for, when it was started for one.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
replayed	boolean	True when this answer is the run first started with the same idempotency key.
selfClearing	object \| null	For runs with failed records: whether they still need a person, are being retried automatically, or were resolved automatically (by a retry or a later run).

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions/{executionId}

Get a run

The run with its steps, errors and recovery state.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions/{executionId}", {
    params: { path: { executionId: "execution_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
flowIdrequired	string
flowVersionIdrequired	string
triggerTyperequired	string
triggerReferencerequired	string \| null
statusrequired	string	For example `queued`, `running`, `succeeded`, `partially_succeeded`, `failed` or `cancelled`.
correlationIdrequired	string
idempotencyKeyrequired	string
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
durationMsrequired	integer \| null
recordsReceivedrequired	integer
recordsProcessedrequired	integer
recordsSucceededrequired	integer
recordsFailedrequired	integer
recordsSkippedrequired	integer
retryCountrequired	integer
deadlineAtrequired	string \| null	ISO 8601 date and time.
endUserId	string \| null	The end user (your customer) this run acted for, when it was started for one.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
replayed	boolean	True when this answer is the run first started with the same idempotency key.
selfClearing	object \| null	For runs with failed records: whether they still need a person, are being retried automatically, or were resolved automatically (by a retry or a later run).
stepsrequired	array of object
errorsrequired	array of object
processingrequired	object
recoveryrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions/{executionId}/steps

List a run's steps

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions/{executionId}/steps", {
    params: { path: { executionId: "execution_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions/{executionId}/records

List a run's records

Each record the run handled, with its status. Up to 1,000.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions/{executionId}/records", {
    params: { path: { executionId: "execution_id" } },
  }),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
sourceRecordIdentifierrequired	string \| null
destinationRecordIdentifierrequired	string \| null
recordTyperequired	string \| null
statusrequired	string
attemptCountrequired	integer
completedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions/{executionId}/records/{recordId}

Get one record of a run

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.
recordId (path)required	string	The record id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions/{executionId}/records/{recordId}", {
    params: { path: { executionId: "execution_id", recordId: "record_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
sourceRecordIdentifierrequired	string \| null
destinationRecordIdentifierrequired	string \| null
recordTyperequired	string \| null
statusrequired	string
attemptCountrequired	integer
completedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions/{executionId}/trace/records

Find records in a run

A run's records for picking one: searched by id, name or amount, filtered and paged on the server. Stopped records come first.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.
search (query)	string	Order, customer or invoice: matches record ids, names and amounts.
filter (query)	string	`all` (default), `stopped`, `rule` (a value was set by your rule) or `skipped`.
page (query)	integer	Page number, from 0.
pageSize (query)	integer	How many to return: 1 to 100, default 50.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions/{executionId}/trace/records", {
    params: { path: { executionId: "execution_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
itemsrequired	array of object
pagerequired	integer
pageSizerequired	integer
totalrequired	integer	Records matching the search and filter.
countsrequired	object
filterrequired	"all" \| "stopped" \| "rule" \| "skipped"
searchrequired	string
keptrequired	boolean	Whether step-by-step details are still kept for this run.
retentionDaysrequired	integer
healthDatarequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/executions/{executionId}/trace/records/{recordId}

See what happened to one record

One record before → what Nexra did → after: each step in plain words, the rules that set values, and a field-by-field view. Sensitive values (email, phone, bank, card, ids, addresses, health data) are partly masked. Details are kept for 30 days unless your plan keeps them longer.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.
recordId (path)required	string	The record id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/executions/{executionId}/trace/records/{recordId}", {
    params: { path: { executionId: "execution_id", recordId: "record_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
statusrequired	"moved" \| "stopped" \| "skipped" \| "in_progress"
keptrequired	boolean
truncatedrequired	boolean	A large value was cut short when it was saved.
expiresAtrequired	string \| null	ISO 8601 date and time.
healthDatarequired	boolean
revealedrequired	boolean
canRevealrequired	boolean
beforerequired	object
didrequired	array of object
afterrequired	object \| null
fieldsrequired	object
stoppedrequired	object \| null
hiddenValuesrequired	integer	How many values are masked in this answer.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/executions/{executionId}/trace/records/{recordId}/reveal

Show one record's hidden values

The same as getting the record, with masked values shown. Workspace owners and admins only; every reveal is recorded in the audit log.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.
recordId (path)required	string	The record id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/executions/{executionId}/trace/records/{recordId}/reveal", {
    params: { path: { executionId: "execution_id", recordId: "record_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
statusrequired	"moved" \| "stopped" \| "skipped" \| "in_progress"
keptrequired	boolean
truncatedrequired	boolean	A large value was cut short when it was saved.
expiresAtrequired	string \| null	ISO 8601 date and time.
healthDatarequired	boolean
revealedrequired	boolean
canRevealrequired	boolean
beforerequired	object
didrequired	array of object
afterrequired	object \| null
fieldsrequired	object
stoppedrequired	object \| null
hiddenValuesrequired	integer	How many values are masked in this answer.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/executions/{executionId}/cancel

Cancel a run

Asks a queued or running run to stop. Records already sent stay sent.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/executions/{executionId}/cancel", {
    params: { path: { executionId: "execution_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
flowIdrequired	string
flowVersionIdrequired	string
triggerTyperequired	string
triggerReferencerequired	string \| null
statusrequired	string	For example `queued`, `running`, `succeeded`, `partially_succeeded`, `failed` or `cancelled`.
correlationIdrequired	string
idempotencyKeyrequired	string
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
durationMsrequired	integer \| null
recordsReceivedrequired	integer
recordsProcessedrequired	integer
recordsSucceededrequired	integer
recordsFailedrequired	integer
recordsSkippedrequired	integer
retryCountrequired	integer
deadlineAtrequired	string \| null	ISO 8601 date and time.
endUserId	string \| null	The end user (your customer) this run acted for, when it was started for one.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
replayed	boolean	True when this answer is the run first started with the same idempotency key.
selfClearing	object \| null	For runs with failed records: whether they still need a person, are being retried automatically, or were resolved automatically (by a retry or a later run).
stepsrequired	array of object
errorsrequired	array of object
processingrequired	object
recoveryrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/executions/{executionId}/retry-failed

Retry a run's failed records

Retries up to 100 of the run's failed records.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
executionId (path)required	string	The execution id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/executions/{executionId}/retry-failed", {
    params: { path: { executionId: "execution_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
executionRecordIdrequired	string \| null
statusrequired	string
idempotencyKeyrequired	string \| null
requestedAtrequired	string	ISO 8601 date and time.
processedAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/monitoring/summary

Get a 24-hour summary

Runs by status, connection health, open failed records and enabled schedules over the last 24 hours.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/monitoring/summary"),
);

Response · 200

Success.

Response fields
Field	Type	Description
windowrequired	object
connectionsrequired	array of object
executionsrequired	array of object
openDeadLettersrequired	integer
enabledSchedulesrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

Schedules

Run a flow on a timetable.

GET/api/console/connect/flows/{flowId}/schedules

List a flow's schedules

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/schedules", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
namerequired	string
cronExpressionrequired	string
timezonerequired	string
enabledrequired	boolean
nextRunAtrequired	string \| null	ISO 8601 date and time.
lastExecutionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/schedules

Create a schedule

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
cronExpressionrequired	string	Five-field cron, for example `0 6 * * 1-5`.
timezone	string	IANA time zone. Default `UTC`.
name	string
enabled	boolean

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/schedules", {
    params: { path: { flowId: "flow_id" } },
    body: {
      "cronExpression": "0 6 * * 1-5"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
namerequired	string
cronExpressionrequired	string
timezonerequired	string
enabledrequired	boolean
nextRunAtrequired	string \| null	ISO 8601 date and time.
lastExecutionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/schedules/{scheduleId}

Update a schedule

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
scheduleId (path)required	string	The schedule id.

Request body · application/json

Request body
Field	Type	Description
cronExpression	string
timezone	string
name	string
enabled	boolean

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/schedules/{scheduleId}", {
    params: { path: { scheduleId: "schedule_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
namerequired	string
cronExpressionrequired	string
timezonerequired	string
enabledrequired	boolean
nextRunAtrequired	string \| null	ISO 8601 date and time.
lastExecutionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

DELETE/api/console/connect/schedules/{scheduleId}

Delete a schedule

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
scheduleId (path)required	string	The schedule id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/schedules/{scheduleId}", {
    params: { path: { scheduleId: "schedule_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/schedules/{scheduleId}/pause

Pause a schedule

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
scheduleId (path)required	string	The schedule id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/schedules/{scheduleId}/pause", {
    params: { path: { scheduleId: "schedule_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
namerequired	string
cronExpressionrequired	string
timezonerequired	string
enabledrequired	boolean
nextRunAtrequired	string \| null	ISO 8601 date and time.
lastExecutionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/schedules/{scheduleId}/resume

Resume a schedule

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
scheduleId (path)required	string	The schedule id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/schedules/{scheduleId}/resume", {
    params: { path: { scheduleId: "schedule_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
flowIdrequired	string
namerequired	string
cronExpressionrequired	string
timezonerequired	string
enabledrequired	boolean
nextRunAtrequired	string \| null	ISO 8601 date and time.
lastExecutionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

Failed records

Records a run could not deliver are held here so you can retry, ignore or resolve them.

GET/api/console/connect/dead-letter

List failed records

Records runs could not deliver, newest first. Up to 500.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`open`, `retry_scheduled`, `retry_failed`, `auto_retry` (being retried automatically), `resolved` or `ignored`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/dead-letter"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
executionRecordIdrequired	string
flowIdrequired	string
statusrequired	string	`open`, `retry_scheduled`, `retry_failed`, `auto_retry` (Nexra is retrying it on its own after a temporary error), `resolved` or `ignored`. Only `open` and `retry_failed` need a person.
retryCountrequired	integer
createdAtrequired	string	ISO 8601 date and time.
lastRetryAtrequired	string \| null	ISO 8601 date and time.
resolvedAtrequired	string \| null	ISO 8601 date and time.
resolutionNoterequired	string \| null
autoRetryState	string \| null	Automatic retries: `retrying`, `needs_person`, `supervised` (the flow is Supervised), `off` or `exhausted`.
autoRetryAttempts	integer
autoRetryMaxAttempts	integer \| null
autoRetryNextAt	string \| null	ISO 8601 date and time.
resolutionKind	string \| null	How it was resolved: `auto_retry` or `later_run` (resolved automatically), `retry` (a person's retry) or `person`.
resolvedByExecutionId	string \| null	The run whose success resolved it.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/dead-letter/{deadLetterId}

Get a failed record

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
deadLetterId (path)required	string	The dead letter id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/dead-letter/{deadLetterId}", {
    params: { path: { deadLetterId: "deadLetter_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
executionRecordIdrequired	string
flowIdrequired	string
statusrequired	string	`open`, `retry_scheduled`, `retry_failed`, `auto_retry` (Nexra is retrying it on its own after a temporary error), `resolved` or `ignored`. Only `open` and `retry_failed` need a person.
retryCountrequired	integer
createdAtrequired	string	ISO 8601 date and time.
lastRetryAtrequired	string \| null	ISO 8601 date and time.
resolvedAtrequired	string \| null	ISO 8601 date and time.
resolutionNoterequired	string \| null
autoRetryState	string \| null	Automatic retries: `retrying`, `needs_person`, `supervised` (the flow is Supervised), `off` or `exhausted`.
autoRetryAttempts	integer
autoRetryMaxAttempts	integer \| null
autoRetryNextAt	string \| null	ISO 8601 date and time.
resolutionKind	string \| null	How it was resolved: `auto_retry` or `later_run` (resolved automatically), `retry` (a person's retry) or `person`.
resolvedByExecutionId	string \| null	The run whose success resolved it.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/dead-letter/{deadLetterId}/retry

Retry a failed record

open, retry_failed and auto_retry records can be retried; a person's retry replaces a waiting automatic one.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
deadLetterId (path)required	string	The dead letter id.

Request body · application/json

Request body
Field	Type	Description
idempotencyKey	string	8 to 160 characters of letters, digits and `. _ : -`. Sending the same key again returns the first result instead of repeating the work.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/dead-letter/{deadLetterId}/retry", {
    params: { path: { deadLetterId: "deadLetter_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
executionRecordIdrequired	string \| null
statusrequired	string
idempotencyKeyrequired	string \| null
requestedAtrequired	string	ISO 8601 date and time.
processedAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/dead-letter/retry

Retry several failed records

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
idsrequired	array of string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/dead-letter/retry", {
    body: {
      "ids": [
        "string"
      ]
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
executionIdrequired	string
executionRecordIdrequired	string \| null
statusrequired	string
idempotencyKeyrequired	string \| null
requestedAtrequired	string	ISO 8601 date and time.
processedAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/dead-letter/{deadLetterId}/ignore

Ignore a failed record

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
deadLetterId (path)required	string	The dead letter id.

Request body · application/json

Request body
Field	Type	Description
note	string	Kept with the record.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/dead-letter/{deadLetterId}/ignore", {
    params: { path: { deadLetterId: "deadLetter_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
executionRecordIdrequired	string
flowIdrequired	string
statusrequired	string	`open`, `retry_scheduled`, `retry_failed`, `auto_retry` (Nexra is retrying it on its own after a temporary error), `resolved` or `ignored`. Only `open` and `retry_failed` need a person.
retryCountrequired	integer
createdAtrequired	string	ISO 8601 date and time.
lastRetryAtrequired	string \| null	ISO 8601 date and time.
resolvedAtrequired	string \| null	ISO 8601 date and time.
resolutionNoterequired	string \| null
autoRetryState	string \| null	Automatic retries: `retrying`, `needs_person`, `supervised` (the flow is Supervised), `off` or `exhausted`.
autoRetryAttempts	integer
autoRetryMaxAttempts	integer \| null
autoRetryNextAt	string \| null	ISO 8601 date and time.
resolutionKind	string \| null	How it was resolved: `auto_retry` or `later_run` (resolved automatically), `retry` (a person's retry) or `person`.
resolvedByExecutionId	string \| null	The run whose success resolved it.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/dead-letter/{deadLetterId}/resolve

Mark a failed record resolved

Use when the record was fixed outside Nexra.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
deadLetterId (path)required	string	The dead letter id.

Request body · application/json

Request body
Field	Type	Description
note	string	Kept with the record.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/dead-letter/{deadLetterId}/resolve", {
    params: { path: { deadLetterId: "deadLetter_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
executionRecordIdrequired	string
flowIdrequired	string
statusrequired	string	`open`, `retry_scheduled`, `retry_failed`, `auto_retry` (Nexra is retrying it on its own after a temporary error), `resolved` or `ignored`. Only `open` and `retry_failed` need a person.
retryCountrequired	integer
createdAtrequired	string	ISO 8601 date and time.
lastRetryAtrequired	string \| null	ISO 8601 date and time.
resolvedAtrequired	string \| null	ISO 8601 date and time.
resolutionNoterequired	string \| null
autoRetryState	string \| null	Automatic retries: `retrying`, `needs_person`, `supervised` (the flow is Supervised), `off` or `exhausted`.
autoRetryAttempts	integer
autoRetryMaxAttempts	integer \| null
autoRetryNextAt	string \| null	ISO 8601 date and time.
resolutionKind	string \| null	How it was resolved: `auto_retry` or `later_run` (resolved automatically), `retry` (a person's retry) or `person`.
resolvedByExecutionId	string \| null	The run whose success resolved it.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/self-clearing/settings

Get automatic retry settings

Whether failed records with a temporary cause (the app was busy, slow or rate limited) are retried on their own, and how many times. Off until an owner or admin turns it on. Waits grow: 1 min, 5 min, 15 min, 1 h, then 6 h, with jitter and the app's Retry-After honoured.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/self-clearing/settings"),
);

Response · 200

Success.

Response fields
Field	Type	Description
enabledrequired	boolean
maxAttemptsrequired	integer
schedulerequired	string	The waits in plain words.
availablerequired	boolean
canManagerequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

PUT/api/console/connect/self-clearing/settings

Change automatic retry settings

Owners and admins. Every automatic retry still follows the workspace's rules and approvals; Supervised flows and payments always wait for a person. Turning it off hands every waiting automatic retry back to a person.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
enabled	boolean
maxAttempts	integer

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PUT("/api/console/connect/self-clearing/settings", {
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
enabledrequired	boolean
maxAttemptsrequired	integer
schedulerequired	string	The waits in plain words.
availablerequired	boolean
canManagerequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

Connections

A connection is an authorised account at a provider. The API returns connection metadata only, never credentials.

GET/api/console/connect/connections

List connections

Connections in the workspace, most recently changed first. Metadata only; credentials are never returned.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
healthStatusrequired	string
authenticationTyperequired	string \| null
providerBaseUrlrequired	string \| null
configurationrequired	object \| null	Non-secret settings for the connector. Never holds credentials.
secretReferencerequired	object \| null	Status of the stored credential. The credential itself is never returned.
credentialExpiresAtrequired	string \| null	ISO 8601 date and time.
lastTestedAtrequired	string \| null	ISO 8601 date and time.
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
liveCheck	object \| null \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/connections

Create a connection

Creates a connection from settings and a stored credential reference. Add the credential itself in the console. A live (production) connection needs a healthy Test mode connection of the same connector as sourceConnectionId.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
connectorKeyrequired	string	From the public connector catalogue.
projectIdrequired	string
namerequired	string
environment	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
slug	string
sourceConnectionId	string
configuration	object	Non-secret, connector-specific settings such as `baseUrl` or `accountReference`. Fields named like passwords, API keys, tokens, client secrets or credentials are refused.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/connections", {
    body: {
      "connectorKey": "string",
      "projectId": "string",
      "name": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
healthStatusrequired	string
authenticationTyperequired	string \| null
providerBaseUrlrequired	string \| null
configurationrequired	object \| null	Non-secret settings for the connector. Never holds credentials.
secretReferencerequired	object \| null	Status of the stored credential. The credential itself is never returned.
credentialExpiresAtrequired	string \| null	ISO 8601 date and time.
lastTestedAtrequired	string \| null	ISO 8601 date and time.
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
liveCheck	object \| null \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}

Get a connection

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
healthStatusrequired	string
authenticationTyperequired	string \| null
providerBaseUrlrequired	string \| null
configurationrequired	object \| null	Non-secret settings for the connector. Never holds credentials.
secretReferencerequired	object \| null	Status of the stored credential. The credential itself is never returned.
credentialExpiresAtrequired	string \| null	ISO 8601 date and time.
lastTestedAtrequired	string \| null	ISO 8601 date and time.
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
liveCheck	object \| null \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/connections/{connectionId}

Update a connection

Changing settings puts the connection back to draft until it is tested again.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Request body · application/json

Request body
Field	Type	Description
name	string
configuration	object	Non-secret, connector-specific settings such as `baseUrl` or `accountReference`. Fields named like passwords, API keys, tokens, client secrets or credentials are refused.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/connections/{connectionId}", {
    params: { path: { connectionId: "connection_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
healthStatusrequired	string
authenticationTyperequired	string \| null
providerBaseUrlrequired	string \| null
configurationrequired	object \| null	Non-secret settings for the connector. Never holds credentials.
secretReferencerequired	object \| null	Status of the stored credential. The credential itself is never returned.
credentialExpiresAtrequired	string \| null	ISO 8601 date and time.
lastTestedAtrequired	string \| null	ISO 8601 date and time.
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
liveCheck	object \| null \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/connections/{connectionId}/test

Test a connection

Calls the provider with the stored credential. A failure answers 400 with the reason in plain words.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Request body · application/json

Request body
Field	Type	Description
correlationId	string	Your own reference for tracing this request across systems (8 to 160 characters).

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/connections/{connectionId}/test", {
    params: { path: { connectionId: "connection_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
statusrequired	"healthy"
latencyMsrequired	integer
detail	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/connections/{connectionId}/disable

Turn a connection off

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/connections/{connectionId}/disable", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
healthStatusrequired	string
authenticationTyperequired	string \| null
providerBaseUrlrequired	string \| null
configurationrequired	object \| null	Non-secret settings for the connector. Never holds credentials.
secretReferencerequired	object \| null	Status of the stored credential. The credential itself is never returned.
credentialExpiresAtrequired	string \| null	ISO 8601 date and time.
lastTestedAtrequired	string \| null	ISO 8601 date and time.
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
liveCheck	object \| null \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}/health

Get connection health

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}/health", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}/capabilities

List what a connection can do

The provider operations this connection can read and write.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}/capabilities", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}/live-check

Get a live connection's latest check

Live connections only.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}/live-check", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
connectionIdrequired	string
staterequired	"not_checked" \| "failed" \| "credentials_changed" \| "expired" \| "passed"
currentrequired	boolean
checkedAtrequired	string \| null	ISO 8601 date and time.
expiresAtrequired	string \| null	ISO 8601 date and time.
summaryrequired	string \| null
fixHint	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/connections/{connectionId}/live-check

Check a live connection now

Confirms the live credential still reaches the right account. Live connections only.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/connections/{connectionId}/live-check", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
connectionIdrequired	string
staterequired	"not_checked" \| "failed" \| "credentials_changed" \| "expired" \| "passed"
currentrequired	boolean
checkedAtrequired	string \| null	ISO 8601 date and time.
expiresAtrequired	string \| null	ISO 8601 date and time.
summaryrequired	string \| null
fixHint	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

End users

Your own customers (end users) and the accounts they connect through your app. Send a short-lived link, record what they agreed to, withdraw access, and answer access and erasure requests.

GET/api/console/connect/end-user-link-apps

List apps your customers can connect through

Your workspace connections that sign in with the provider's own page and have your app's client ID and secret saved. Customers connect through your own app; their sign-in runs under your app's keys.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/end-user-link-apps"),
);

Response · 200

Success.

Response fields
Field	Type	Description
appsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/end-users

List end users

Your customers and the accounts they connected, newest first.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`active` (default), `erased` or `all`.
connectorKey (query)	string	Only customers with a current connection to this app, for example `xero`.
q (query)	string	Search your id, name or email.
limit (query)	integer	How many to return: 1 to 100, default 50.
offset (query)	integer	How many to skip.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/end-users"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
totalrequired	integer
endUsersrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/end-users

Add an end user

Adds a customer by your own id for them, or updates the name and email of one you already added. Scoped to the workspace, or to one project when projectId is given.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
externalUserIdrequired	string
projectId	string
displayName	string
email	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/end-users", {
    body: {
      "externalUserId": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
externalUserIdrequired	string \| null	Your id for the customer. Null after erasure.
displayNamerequired	string \| null
emailrequired	string \| null
projectIdrequired	string \| null
statusrequired	"active" \| "erased"
createdAtrequired	string	ISO 8601 date and time.
erasedAtrequired	string \| null	ISO 8601 date and time.
connectionsrequired	array of object
consentsrequired	array of object
linksrequired	array of object
dataRequestsrequired	array of object
runsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/end-users/{endUserId}

Get an end user

The customer with their connections, consent history, links, data requests and recent runs.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endUserId (path)required	string	The end user id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/end-users/{endUserId}", {
    params: { path: { endUserId: "endUser_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
externalUserIdrequired	string \| null	Your id for the customer. Null after erasure.
displayNamerequired	string \| null
emailrequired	string \| null
projectIdrequired	string \| null
statusrequired	"active" \| "erased"
createdAtrequired	string	ISO 8601 date and time.
erasedAtrequired	string \| null	ISO 8601 date and time.
connectionsrequired	array of object
consentsrequired	array of object
linksrequired	array of object
dataRequestsrequired	array of object
runsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/end-users/{endUserId}/links

Create a link for an end user

A short-lived, single-use, signed link to send your customer. connect opens a page that explains your purpose in plain words, records their agreement and then sends them to the app's own sign-in page; manage lets them see and withdraw what they connected. Links last 30 minutes unless you choose 5 to 120.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endUserId (path)required	string	The end user id.

Request body · application/json

Request body
Field	Type	Description
kind	"connect" \| "manage"
appConnectionId	string	Required for `connect`: from `listEndUserLinkApps`.
purpose	string	Required for `connect`: why you need the connection, shown to the customer word for word.
purposeKey	string	Your short label for this purpose.
account	object	Account details the app needs, if you know them (for example a store or subdomain name).
returnUrl	string	Where to send the customer afterwards (https).
expiresInMinutes	integer

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/end-users/{endUserId}/links", {
    params: { path: { endUserId: "endUser_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
linkIdrequired	string
kindrequired	"connect" \| "manage"
endUserIdrequired	string
connectorKeyrequired	string \| null
appNamerequired	string \| null
urlrequired	string	Send this to your customer. It works once and expires.
expiresAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/end-users/{endUserId}/connections/{connectionId}/revoke

Withdraw an end user's connection

Deletes the stored access, turns the connection off and marks its consent revoked (the consent record is kept). Set onBehalfOfEndUser when your customer asked for it.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endUserId (path)required	string	The end user id.
connectionId (path)required	string	The connection id.

Request body · application/json

Request body
Field	Type	Description
reason	string
onBehalfOfEndUser	boolean

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/end-users/{endUserId}/connections/{connectionId}/revoke", {
    params: { path: { endUserId: "endUser_id", connectionId: "connection_id" } },
    body: {},
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/end-users/{endUserId}/access-requests

Export what is held about an end user

Records an access request and returns the export: connections, consent records, links and run metadata. Sign-in secrets are never included.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endUserId (path)required	string	The end user id.

Request body · application/json

Request body
Field	Type	Description
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/end-users/{endUserId}/access-requests", {
    params: { path: { endUserId: "endUser_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
requestrequired	object
exportrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/end-users/{endUserId}/erasure-requests

Ask to erase an end user

Records an erasure request. Nothing is erased until a workspace owner or admin approves it in the console; then stored access is deleted, personal data is cleared from run records and a minimal record of the erasure is kept.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endUserId (path)required	string	The end user id.

Request body · application/json

Request body
Field	Type	Description
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/end-users/{endUserId}/erasure-requests", {
    params: { path: { endUserId: "endUser_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
endUserIdrequired	string
kindrequired	"access" \| "erasure"
statusrequired	string	`pending_approval`, `in_progress`, `completed`, `rejected` or `failed`.
reasonrequired	string \| null
requestedByTyperequired	string
decidedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
evidencerequired	object \| null	What was done, as counts and hashes. Never personal data.
evidenceHashrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/data-requests

List access and erasure requests

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	For example `pending_approval` or `completed`.
kind (query)	string	`access` or `erasure`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/data-requests"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
requestsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/data-requests/{requestId}

Get an access or erasure request

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
requestId (path)required	string	The request id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/data-requests/{requestId}", {
    params: { path: { requestId: "request_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
endUserIdrequired	string
kindrequired	"access" \| "erasure"
statusrequired	string	`pending_approval`, `in_progress`, `completed`, `rejected` or `failed`.
reasonrequired	string \| null
requestedByTyperequired	string
decidedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
evidencerequired	object \| null	What was done, as counts and hashes. Never personal data.
evidenceHashrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/data-requests/{requestId}/export

Download an access export again

Generated again now. Not available once the end user has been erased.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
requestId (path)required	string	The request id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/data-requests/{requestId}/export", {
    params: { path: { requestId: "request_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

Records

Your workspace's own records that flows use: contract obligations and their reminders, the asset-to-customer map, evidence matrices for review, and statements made from a template. Each waits for a person where it should.

GET/api/console/connect/builtin-operations

List Nexra built-in operations

The operations a flow step of kind builtin can run on your workspace's own records, with their fields: obligations.create, obligations.list, obligations.update, obligations.complete, evidence_matrix.create, asset_customers.list, statements.generate and statements.get.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/builtin-operations"),
);

Response · 200

Success.

Response fields
Field	Type	Description
operationsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/obligations

List obligations

Obligations ordered by due date, with counts of open, due soon and overdue ones.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`open`, `due_soon`, `overdue`, `done`, `waived` or `active` (anything not done or waived).
q (query)	string	Search the reference, counterparty, obligation and clause.
reference (query)	string	Only this contract or agreement.
ownerUserId (query)	string	Only obligations this member owns.
kind (query)	string	`returns` for returns and filings, or `obligation`, `return` or `filing`.
regulator (query)	string	Only this regulator (exact, any case).
limit (query)	integer	How many to return: 1 to 500, default 200.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/obligations"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
totalrequired	integer
countsrequired	object
regulatorsrequired	array of string	The regulators this workspace entered, for a filter.
obligationsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/obligations

Add an obligation

Nexra reminds the owner before it is due (14 days unless you choose otherwise) and when it is overdue.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
referencerequired	string
counterpartyrequired	string
textrequired	string
dueDaterequired	string	YYYY-MM-DD. For a repeating obligation, the next due date.
recurrence	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
sourceClause	string
ownerUserId	string	A member of the workspace (from `listObligationOwners`).
ownerTeam	string
reminderLeadDays	integer	Default 14.
evidenceLinks	array of string
kind	"obligation" \| "return" \| "filing"	Default `obligation`. Set when it is added.
regulator	string	Required for a return or filing.
period	string
periodStart	string	YYYY-MM-DD.
periodEnd	string	YYYY-MM-DD.
checkerUserId	string	Who approves a return's file: a different member from the owner.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/obligations", {
    body: {
      "reference": "Gas supply agreement GSA-2024-07",
      "counterparty": "Northfield Power",
      "text": "Send the monthly volume statement",
      "dueDate": "2026-10-31",
      "recurrence": "monthly",
      "sourceClause": "7.2",
      "ownerTeam": "Finance",
      "reminderLeadDays": 14
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
referencerequired	string	The contract or agreement reference.
counterpartyrequired	string
textrequired	string	What is owed, in plain words.
ownerrequired	object \| null	A workspace member (by name) or a team. Never an email address.
recurrencerequired	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
dueDaterequired	string	The next due date (YYYY-MM-DD).
sourceClauserequired	string \| null
statusrequired	"open" \| "due_soon" \| "overdue" \| "done" \| "waived"	`due_soon` and `overdue` are worked out from the due date and the reminder lead time.
reminderLeadDaysrequired	integer
evidenceLinksrequired	array of string
lastCompletedAtrequired	string \| null	ISO 8601 date and time.
completedCountrequired	integer
waivedReasonrequired	string \| null
kindrequired	"obligation" \| "return" \| "filing"	A return or filing is filed with a regulator by a person. It closes only with proof (`markObligationFiled`).
regulatorrequired	string \| null
periodrequired	string \| null	The period it covers, for example `Q3 2026`.
periodStartrequired	string \| null
periodEndrequired	string \| null
checkerrequired	object \| null	The member who approves a return's file. Never the person who prepared it.
filingrequired	object \| null	Where a return stands. Null for other obligations.
sourcerequired	string
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/obligation-owners

List who can own an obligation

Active workspace members, by name only.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/obligation-owners"),
);

Response · 200

Success.

Response fields
Field	Type	Description
membersrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/obligations/{obligationId}

Get an obligation

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/obligations/{obligationId}", {
    params: { path: { obligationId: "obligation_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
referencerequired	string	The contract or agreement reference.
counterpartyrequired	string
textrequired	string	What is owed, in plain words.
ownerrequired	object \| null	A workspace member (by name) or a team. Never an email address.
recurrencerequired	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
dueDaterequired	string	The next due date (YYYY-MM-DD).
sourceClauserequired	string \| null
statusrequired	"open" \| "due_soon" \| "overdue" \| "done" \| "waived"	`due_soon` and `overdue` are worked out from the due date and the reminder lead time.
reminderLeadDaysrequired	integer
evidenceLinksrequired	array of string
lastCompletedAtrequired	string \| null	ISO 8601 date and time.
completedCountrequired	integer
waivedReasonrequired	string \| null
kindrequired	"obligation" \| "return" \| "filing"	A return or filing is filed with a regulator by a person. It closes only with proof (`markObligationFiled`).
regulatorrequired	string \| null
periodrequired	string \| null	The period it covers, for example `Q3 2026`.
periodStartrequired	string \| null
periodEndrequired	string \| null
checkerrequired	object \| null	The member who approves a return's file. Never the person who prepared it.
filingrequired	object \| null	Where a return stands. Null for other obligations.
sourcerequired	string
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/obligations/{obligationId}

Change an obligation

Send only the fields to change. To waive it, send status: waived with waivedReason; to reopen it, status: open.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Request body · application/json

Request body
Field	Type	Description
reference	string
counterparty	string
text	string
dueDate	string	YYYY-MM-DD. For a repeating obligation, the next due date.
recurrence	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
sourceClause	string
ownerUserId	string	A member of the workspace (from `listObligationOwners`).
ownerTeam	string
reminderLeadDays	integer	Default 14.
evidenceLinks	array of string
kind	"obligation" \| "return" \| "filing"	Default `obligation`. Set when it is added.
regulator	string	Required for a return or filing.
period	string
periodStart	string	YYYY-MM-DD.
periodEnd	string	YYYY-MM-DD.
checkerUserId	string	Who approves a return's file: a different member from the owner.
status	"waived" \| "open"
waivedReason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/obligations/{obligationId}", {
    params: { path: { obligationId: "obligation_id" } },
    body: {
      "reference": "Gas supply agreement GSA-2024-07",
      "counterparty": "Northfield Power",
      "text": "Send the monthly volume statement",
      "dueDate": "2026-10-31",
      "recurrence": "monthly",
      "sourceClause": "7.2",
      "ownerTeam": "Finance",
      "reminderLeadDays": 14
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
referencerequired	string	The contract or agreement reference.
counterpartyrequired	string
textrequired	string	What is owed, in plain words.
ownerrequired	object \| null	A workspace member (by name) or a team. Never an email address.
recurrencerequired	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
dueDaterequired	string	The next due date (YYYY-MM-DD).
sourceClauserequired	string \| null
statusrequired	"open" \| "due_soon" \| "overdue" \| "done" \| "waived"	`due_soon` and `overdue` are worked out from the due date and the reminder lead time.
reminderLeadDaysrequired	integer
evidenceLinksrequired	array of string
lastCompletedAtrequired	string \| null	ISO 8601 date and time.
completedCountrequired	integer
waivedReasonrequired	string \| null
kindrequired	"obligation" \| "return" \| "filing"	A return or filing is filed with a regulator by a person. It closes only with proof (`markObligationFiled`).
regulatorrequired	string \| null
periodrequired	string \| null	The period it covers, for example `Q3 2026`.
periodStartrequired	string \| null
periodEndrequired	string \| null
checkerrequired	object \| null	The member who approves a return's file. Never the person who prepared it.
filingrequired	object \| null	Where a return stands. Null for other obligations.
sourcerequired	string
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/obligations/{obligationId}/complete

Mark an obligation done

Completes the current due date. A repeating obligation moves on to its next due date and stays open. A return or filing can't be completed here: a person marks it filed with proof (markObligationFiled).

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Request body · application/json

Request body
Field	Type	Description
evidenceLinks	array of string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/obligations/{obligationId}/complete", {
    params: { path: { obligationId: "obligation_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
referencerequired	string	The contract or agreement reference.
counterpartyrequired	string
textrequired	string	What is owed, in plain words.
ownerrequired	object \| null	A workspace member (by name) or a team. Never an email address.
recurrencerequired	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
dueDaterequired	string	The next due date (YYYY-MM-DD).
sourceClauserequired	string \| null
statusrequired	"open" \| "due_soon" \| "overdue" \| "done" \| "waived"	`due_soon` and `overdue` are worked out from the due date and the reminder lead time.
reminderLeadDaysrequired	integer
evidenceLinksrequired	array of string
lastCompletedAtrequired	string \| null	ISO 8601 date and time.
completedCountrequired	integer
waivedReasonrequired	string \| null
kindrequired	"obligation" \| "return" \| "filing"	A return or filing is filed with a regulator by a person. It closes only with proof (`markObligationFiled`).
regulatorrequired	string \| null
periodrequired	string \| null	The period it covers, for example `Q3 2026`.
periodStartrequired	string \| null
periodEndrequired	string \| null
checkerrequired	object \| null	The member who approves a return's file. Never the person who prepared it.
filingrequired	object \| null	Where a return stands. Null for other obligations.
sourcerequired	string
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/obligations/{obligationId}/filing

Get a return's file, checks and proof

The prepared file, the checks (calculated by Nexra, no AI), the approval and the proof of filing. Nexra prepares and reminds; a person files with the regulator.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/obligations/{obligationId}/filing", {
    params: { path: { obligationId: "obligation_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
obligationrequired	object
copyrequired	string
filingrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/obligations/{obligationId}/filing/prepare

Prepare a return's file

Generate the file from figures (source: generated, xlsx or csv), use a statement (statementId) or a draft uploaded to /obligations/:obligationId/files (fileId). The checks are calculated straight away. A file waiting for approval or approved can't be replaced.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Request body · application/json

Request body
Field	Type	Description
sourcerequired	"generated" \| "statement" \| "upload"
format	"xlsx" \| "csv"
fileName	string
fileId	string
statementId	string
figures	object

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/obligations/{obligationId}/filing/prepare", {
    params: { path: { obligationId: "obligation_id" } },
    body: {
      "source": "generated"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
obligationrequired	object
copyrequired	string
filingrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/obligations/{obligationId}/filing/notes

Add notes on flagged figures

Notes by figure key, for example on a large movement. The checks are calculated again.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Request body · application/json

Request body
Field	Type	Description
notesrequired	object

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/obligations/{obligationId}/filing/notes", {
    params: { path: { obligationId: "obligation_id" } },
    body: {
      "notes": {}
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
obligationrequired	object
copyrequired	string
filingrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/obligations/{obligationId}/filing/approval

Send a return's file for approval

Opens a review task in the workspace approvals. Only the person who prepared the file sends it, and they can't approve it. Every check must pass first.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/obligations/{obligationId}/filing/approval", {
    params: { path: { obligationId: "obligation_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
obligationrequired	object
copyrequired	string
filingrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/obligations/{obligationId}/filing/decision

Approve a return for filing or send it back

A different member with approval rights decides. Sending it back needs a reason. The file is locked once approved.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Request body · application/json

Request body
Field	Type	Description
decisionrequired	"approved" \| "rejected"
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/obligations/{obligationId}/filing/decision", {
    params: { path: { obligationId: "obligation_id" } },
    body: {
      "decision": "approved"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
obligationrequired	object
copyrequired	string
filingrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/obligations/{obligationId}/filing/filed

Mark a return as filed

Records that a person filed the approved return with the regulator. Proof is required: the acknowledgement file (uploaded to /obligations/:obligationId/files), the filing reference, the date filed and who filed. For a repeating return the next period's obligation is created.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
obligationId (path)required	string	The obligation id.

Request body · application/json

Request body
Field	Type	Description
proofFileIdrequired	string
filingReferencerequired	string
filedOnrequired	string	YYYY-MM-DD, not in the future.
filedByUserId	string
filedByName	string	When the person who filed isn't a workspace member.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/obligations/{obligationId}/filing/filed", {
    params: { path: { obligationId: "obligation_id" } },
    body: {
      "proofFileId": "string",
      "filingReference": "string",
      "filedOn": "string"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
obligationrequired	object
copyrequired	string
filingrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/asset-customers

List the asset-to-customer map

Which customers each asset or segment serves. Filter by one asset for the customers it affects.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
asset (query)	string	Only this asset or segment (exact, any case).
q (query)	string	Search assets, customers and CRM ids.
limit (query)	integer	How many to return: 1 to 1,000, default 200.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/asset-customers"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
totalrequired	integer
customersrequired	array of object
assetsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/asset-customers

Add a customer to an asset

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
assetKeyrequired	string
assetName	string
customerNamerequired	string
crmId	string
externalId	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/asset-customers", {
    body: {
      "assetKey": "string",
      "customerName": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
savedrequired	integer
removedrequired	integer
assetsrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/asset-customers/upload

Upload the asset-to-customer map

CSV text with asset and customer columns (optional: asset_name, crm_id, external_id). add keeps existing rows; replace first removes the customers of every asset in the file.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
csvrequired	string
mode	"add" \| "replace"

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/asset-customers/upload", {
    body: {
      "csv": "asset,customer,crm_id\nSection 4,Northfield Power,0015g00000ABCDE\nSection 4,Riverside Bakery,0015g00000FGHIJ",
      "mode": "add"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
savedrequired	integer
removedrequired	integer
assetsrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

DELETE/api/console/connect/asset-customers/{assetCustomerId}

Remove a customer from an asset

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
assetCustomerId (path)required	string	The asset customer id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/asset-customers/{assetCustomerId}", {
    params: { path: { assetCustomerId: "assetCustomer_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
removedrequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/evidence-matrices

List evidence matrices

Needs a role that manages records or decides approvals: matrices can hold people's details.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`pending_review`, `reviewed` or `returned`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/evidence-matrices"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
matricesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/evidence-matrices

Make an evidence matrix

Rows by criteria, each cell evidenced (with a quote) or not evidenced, plus clarification questions. Opens a review task. Scores, ranks, outcomes and criteria about protected characteristics are refused.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
titlerequired	string
subject	string	What the rows are, for example `candidates`.
criteriarequired	array of object
rowsrequired	array of object
questions	array of object

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/evidence-matrices", {
    body: {
      "title": "Site engineer applications, October",
      "subject": "candidates",
      "criteria": [
        {
          "key": "gas_safe",
          "label": "Holds a current Gas Safe registration"
        },
        {
          "key": "experience",
          "label": "Three years of network maintenance experience"
        }
      ],
      "rows": [
        {
          "key": "candidate_a",
          "label": "Candidate A",
          "cells": {
            "gas_safe": {
              "status": "evidenced",
              "quote": "Gas Safe registered since 2019",
              "source": "CV, page 1"
            },
            "experience": {
              "status": "not_evidenced"
            }
          }
        }
      ],
      "questions": [
        {
          "rowKey": "candidate_a",
          "question": "How many years of network maintenance have you done?"
        }
      ]
    },
  }),
);

Response · 201

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/evidence-matrices/{matrixId}

Get an evidence matrix

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
matrixId (path)required	string	The matrix id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/evidence-matrices/{matrixId}", {
    params: { path: { matrixId: "matrix_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
titlerequired	string
subjectrequired	string
statusrequired	"pending_review" \| "reviewed" \| "returned"
criteriarequired	array of object
rowsrequired	array of object
questionsrequired	array of object
reviewrequired	object \| null
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/evidence-matrices/{matrixId}/review

Send an evidence matrix for review

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
matrixId (path)required	string	The matrix id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/evidence-matrices/{matrixId}/review", {
    params: { path: { matrixId: "matrix_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
titlerequired	string
subjectrequired	string
statusrequired	"pending_review" \| "reviewed" \| "returned"
criteriarequired	array of object
rowsrequired	array of object
questionsrequired	array of object
reviewrequired	object \| null
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/evidence-matrices/{matrixId}/decision

Review an evidence matrix

Mark it reviewed (approved) or send it back (rejected, with a reason). The person who sent it for review can't decide it.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
matrixId (path)required	string	The matrix id.

Request body · application/json

Request body
Field	Type	Description
decisionrequired	"approved" \| "rejected"
reason	string	Needed when sending it back.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/evidence-matrices/{matrixId}/decision", {
    params: { path: { matrixId: "matrix_id" } },
    body: {
      "decision": "approved"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
titlerequired	string
subjectrequired	string
statusrequired	"pending_review" \| "reviewed" \| "returned"
criteriarequired	array of object
rowsrequired	array of object
questionsrequired	array of object
reviewrequired	object \| null
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/statements

List statements

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`pending_approval`, `approved` or `rejected`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/statements"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
statementsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/statements

Make a statement

Makes a monthly volume statement from your data (totals are worked out by Nexra) and opens its approval. Nothing can send it until it is approved.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
template	"monthly_volume"
title	string
customerNamerequired	string
customerRef	string
periodStartrequired	string	YYYY-MM-DD
periodEndrequired	string	YYYY-MM-DD
unit	string
daysrequired	array of object
invoices	array of object
note	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/statements", {
    body: {
      "template": "monthly_volume",
      "customerName": "Northfield Power",
      "customerRef": "ACC-1042",
      "periodStart": "2026-09-01",
      "periodEnd": "2026-09-30",
      "unit": "MWh",
      "days": [
        {
          "date": "2026-09-01",
          "volume": 412.5
        },
        {
          "date": "2026-09-02",
          "volume": 398.2
        }
      ],
      "invoices": [
        {
          "reference": "INV-2026-0931",
          "amount": 48250,
          "currency": "GBP"
        }
      ],
      "note": "Volumes are from the network meter at the delivery point."
    },
  }),
);

Response · 201

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/statements/{statementId}

Get a statement

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
statementId (path)required	string	The statement id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/statements/{statementId}", {
    params: { path: { statementId: "statement_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
titlerequired	string
templaterequired	string
customerNamerequired	string
periodStartrequired	string
periodEndrequired	string
statusrequired	"pending_approval" \| "approved" \| "rejected"
htmlrequired	string	The statement as a printable HTML page.
reviewrequired	object \| null
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/statements/{statementId}/approval

Send a statement for approval

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
statementId (path)required	string	The statement id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/statements/{statementId}/approval", {
    params: { path: { statementId: "statement_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
titlerequired	string
templaterequired	string
customerNamerequired	string
periodStartrequired	string
periodEndrequired	string
statusrequired	"pending_approval" \| "approved" \| "rejected"
htmlrequired	string	The statement as a printable HTML page.
reviewrequired	object \| null
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/statements/{statementId}/decision

Approve a statement

Approve it, or send it back with a reason. The person who sent it for approval can't decide it.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
statementId (path)required	string	The statement id.

Request body · application/json

Request body
Field	Type	Description
decisionrequired	"approved" \| "rejected"
reason	string	Needed when sending it back.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/statements/{statementId}/decision", {
    params: { path: { statementId: "statement_id" } },
    body: {
      "decision": "approved"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
titlerequired	string
templaterequired	string
customerNamerequired	string
periodStartrequired	string
periodEndrequired	string
statusrequired	"pending_approval" \| "approved" \| "rejected"
htmlrequired	string	The statement as a printable HTML page.
reviewrequired	object \| null
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

Triggers

Start flows from signed webhooks, provider events, polling or uploaded files.

GET/api/console/connect/trigger-catalogue

List provider events that can start flows

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/trigger-catalogue"),
);

Response · 200

Success.

Response fields
Field	Type	Description
providerrequired	string
namerequired	string
schemerequired	string
setuprequired	string
eventsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/triggers

List a flow's webhook triggers

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/triggers", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
triggerIdrequired	string
flowIdrequired	string
kindrequired	string
namerequired	string
statusrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
urlrequired	string	Where senders post events: `/api/connect/triggers/{publicId}`.
secretLast4required	string \| null
secretRotatedAtrequired	string \| null	ISO 8601 date and time.
previousSecretValidUntilrequired	string \| null	ISO 8601 date and time.
maxBodyBytesrequired	integer
maxDeliveriesPerMinuterequired	integer
timestampToleranceSecondsrequired	integer
inputRetentionDaysrequired	integer
verificationrequired	string
lastDeliveryAtrequired	string \| null	ISO 8601 date and time.
disabledAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/triggers

Create a webhook trigger

Gives the flow a URL that starts a run when a signed request arrives. Without connectionId it is a signed trigger: by default Nexra makes a signing secret (nexra_v1) and returns it once. With connectionId and events it listens to that provider's events. Provider-issued signing secrets are added in the console.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
name	string
environment	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
verification	string	How requests are verified. Default `nexra_v1`; provider schemes include `shopify`, `stripe` and `github`.
eventTypes	array of string
shopDomain	string	Shopify only.
connectionId	string	Listen to this connection's provider events.
events	array of string	Event keys from the connection's event list.
setup	"automatic" \| "guided"
maxBodyBytes	integer	Default 65,536.
maxDeliveriesPerMinute	integer	Default 60.
timestampToleranceSeconds	integer	Default 300.
inputRetentionDays	integer	Default 7.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/triggers", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
triggerIdrequired	string
flowIdrequired	string
kindrequired	string
namerequired	string
statusrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
urlrequired	string	Where senders post events: `/api/connect/triggers/{publicId}`.
secretLast4required	string \| null
secretRotatedAtrequired	string \| null	ISO 8601 date and time.
previousSecretValidUntilrequired	string \| null	ISO 8601 date and time.
maxBodyBytesrequired	integer
maxDeliveriesPerMinuterequired	integer
timestampToleranceSecondsrequired	integer
inputRetentionDaysrequired	integer
verificationrequired	string
lastDeliveryAtrequired	string \| null	ISO 8601 date and time.
disabledAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
secret	string	The signing secret (`nxwhsec_...`). Shown once, only when Nexra made it. Store it safely.
secretShownOncerequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/triggers/{triggerId}

Get a webhook trigger

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
triggerId (path)required	string	The trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/triggers/{triggerId}", {
    params: { path: { triggerId: "trigger_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
triggerIdrequired	string
flowIdrequired	string
kindrequired	string
namerequired	string
statusrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
urlrequired	string	Where senders post events: `/api/connect/triggers/{publicId}`.
secretLast4required	string \| null
secretRotatedAtrequired	string \| null	ISO 8601 date and time.
previousSecretValidUntilrequired	string \| null	ISO 8601 date and time.
maxBodyBytesrequired	integer
maxDeliveriesPerMinuterequired	integer
timestampToleranceSecondsrequired	integer
inputRetentionDaysrequired	integer
verificationrequired	string
lastDeliveryAtrequired	string \| null	ISO 8601 date and time.
disabledAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

DELETE/api/console/connect/triggers/{triggerId}

Delete a trigger

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
triggerId (path)required	string	The trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/triggers/{triggerId}", {
    params: { path: { triggerId: "trigger_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/triggers/{triggerId}/rotate

Rotate a trigger's signing secret

Makes a new signing secret, returned once. The old one keeps working for graceMinutes.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
triggerId (path)required	string	The trigger id.

Request body · application/json

Request body
Field	Type	Description
graceMinutes	integer

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/triggers/{triggerId}/rotate", {
    params: { path: { triggerId: "trigger_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
triggerIdrequired	string
flowIdrequired	string
kindrequired	string
namerequired	string
statusrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
urlrequired	string	Where senders post events: `/api/connect/triggers/{publicId}`.
secretLast4required	string \| null
secretRotatedAtrequired	string \| null	ISO 8601 date and time.
previousSecretValidUntilrequired	string \| null	ISO 8601 date and time.
maxBodyBytesrequired	integer
maxDeliveriesPerMinuterequired	integer
timestampToleranceSecondsrequired	integer
inputRetentionDaysrequired	integer
verificationrequired	string
lastDeliveryAtrequired	string \| null	ISO 8601 date and time.
disabledAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
secret	string	The signing secret (`nxwhsec_...`). Shown once, only when Nexra made it. Store it safely.
secretShownOncerequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/triggers/{triggerId}/register

Register a trigger with the provider

For triggers with automatic setup: asks the provider to start sending events.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
triggerId (path)required	string	The trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/triggers/{triggerId}/register", {
    params: { path: { triggerId: "trigger_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
triggerIdrequired	string
flowIdrequired	string
kindrequired	string
namerequired	string
statusrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
urlrequired	string	Where senders post events: `/api/connect/triggers/{publicId}`.
secretLast4required	string \| null
secretRotatedAtrequired	string \| null	ISO 8601 date and time.
previousSecretValidUntilrequired	string \| null	ISO 8601 date and time.
maxBodyBytesrequired	integer
maxDeliveriesPerMinuterequired	integer
timestampToleranceSecondsrequired	integer
inputRetentionDaysrequired	integer
verificationrequired	string
lastDeliveryAtrequired	string \| null	ISO 8601 date and time.
disabledAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/triggers/{triggerId}/disable

Turn a trigger off

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
triggerId (path)required	string	The trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/triggers/{triggerId}/disable", {
    params: { path: { triggerId: "trigger_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
triggerIdrequired	string
flowIdrequired	string
kindrequired	string
namerequired	string
statusrequired	string
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
urlrequired	string	Where senders post events: `/api/connect/triggers/{publicId}`.
secretLast4required	string \| null
secretRotatedAtrequired	string \| null	ISO 8601 date and time.
previousSecretValidUntilrequired	string \| null	ISO 8601 date and time.
maxBodyBytesrequired	integer
maxDeliveriesPerMinuterequired	integer
timestampToleranceSecondsrequired	integer
inputRetentionDaysrequired	integer
verificationrequired	string
lastDeliveryAtrequired	string \| null	ISO 8601 date and time.
disabledAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/triggers/{triggerId}/deliveries

List a trigger's deliveries

The latest 100 requests the trigger received, accepted or refused.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
triggerId (path)required	string	The trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/triggers/{triggerId}/deliveries", {
    params: { path: { triggerId: "trigger_id" } },
  }),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
deliveryIdrequired	string
receivedAtrequired	string
statusrequired	string
reasonCoderequired	string \| null
httpStatusrequired	integer \| null
eventIdrequired	string \| null
eventTyperequired	string \| null
payloadSha256required	string \| null
sizeBytesrequired	integer \| null
recordCountrequired	integer \| null
executionIdrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}/trigger-events

List a connection's webhook events

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}/trigger-events", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
connectionIdrequired	string
providerrequired	string
availablerequired	boolean
eventsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}/record-events

List a connection's pollable events

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}/record-events", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
connectionIdrequired	string
providerrequired	string
availablerequired	boolean
eventsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/poll-triggers

List a flow's polling triggers

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/poll-triggers", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/poll-triggers

Create a polling trigger

Checks the provider on a timetable and starts a run for new or changed records.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
connectionIdrequired	string
event	string	`poll:<operationKey>`, from the connection's pollable events.
operationKey	string	Instead of `event`.
intervalMinutes	5 \| 15 \| 60 \| 1440	Minutes between checks: 5, 15, 60 or 1440.
environment	"sandbox" \| "production"	Must match the connection.
input	object
name	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/poll-triggers", {
    params: { path: { flowId: "flow_id" } },
    body: {
      "connectionId": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/poll-triggers/{pollTriggerId}

Get a polling trigger

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
pollTriggerId (path)required	string	The poll trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/poll-triggers/{pollTriggerId}", {
    params: { path: { pollTriggerId: "pollTrigger_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/poll-triggers/{pollTriggerId}

Change how often a polling trigger checks

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
pollTriggerId (path)required	string	The poll trigger id.

Request body · application/json

Request body
Field	Type	Description
intervalMinutesrequired	5 \| 15 \| 60 \| 1440	Minutes between checks: 5, 15, 60 or 1440.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/poll-triggers/{pollTriggerId}", {
    params: { path: { pollTriggerId: "pollTrigger_id" } },
    body: {
      "intervalMinutes": 5
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

DELETE/api/console/connect/poll-triggers/{pollTriggerId}

Delete a polling trigger

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
pollTriggerId (path)required	string	The poll trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/poll-triggers/{pollTriggerId}", {
    params: { path: { pollTriggerId: "pollTrigger_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/poll-triggers/{pollTriggerId}/pause

Pause a polling trigger

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
pollTriggerId (path)required	string	The poll trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/poll-triggers/{pollTriggerId}/pause", {
    params: { path: { pollTriggerId: "pollTrigger_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/poll-triggers/{pollTriggerId}/resume

Resume a polling trigger

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
pollTriggerId (path)required	string	The poll trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/poll-triggers/{pollTriggerId}/resume", {
    params: { path: { pollTriggerId: "pollTrigger_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/poll-triggers/{pollTriggerId}/check-now

Check now

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
pollTriggerId (path)required	string	The poll trigger id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/poll-triggers/{pollTriggerId}/check-now", {
    params: { path: { pollTriggerId: "pollTrigger_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
pollTriggerIdrequired	string
flowIdrequired	string
kindrequired	"poll"
namerequired	string
connectionIdrequired	string
operationKeyrequired	string
intervalMinutesrequired	integer
environmentrequired	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
statusrequired	string
staterequired	string
stateMessagerequired	string \| null
lastCheckedAtrequired	string \| null	ISO 8601 date and time.
nextCheckAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/flows/{flowId}/inputs

List a flow's uploaded files

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/flows/{flowId}/inputs", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
inputIdrequired	string
flowIdrequired	string
formatrequired	string
fileNamerequired	string \| null
sizeBytesrequired	integer
sha256required	string
recordCountrequired	integer
executionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
expiresAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/inputs

Upload a file for a flow

Send the raw file as the request body with Content-Type: text/csv or application/json. Then start a run with the returned inputId. Records that do not match the flow's input answer 422.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.
fileName (query)	string	The original file name, for display.
environment (query)	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.

Request body · text/csv

See the description above.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/inputs", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
inputIdrequired	string
flowIdrequired	string
formatrequired	string
fileNamerequired	string \| null
sizeBytesrequired	integer
sha256required	string
recordCountrequired	integer
executionIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
expiresAtrequired	string \| null	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/connect/triggers/{publicId}

Send an event to a webhook trigger

Public URL for senders. Sign the raw body: X-Nexra-Signature: v1=<hex HMAC-SHA256> over v1:<timestamp>:<eventId>:<raw body>, keyed with the trigger's secret. Each event id is used once; a repeat with the same body answers 200 with duplicate: true. Refusals answer { accepted: false, code }.

Signed with the trigger's secret

Send X-Nexra-Event-Id, X-Nexra-Timestamp and X-Nexra-Signature. No access token.

Parameters

Parameters
Field	Type	Description
publicId (path)required	string	The trigger's public id from its `url`.
X-Nexra-Event-Id (header)required	string	Unique per event: 8 to 128 of `A-Z a-z 0-9 . _ : -`.
X-Nexra-Timestamp (header)required	string	Unix seconds when you signed.

Request body · application/json

See the description above.

Examples

curl

curl -X POST "https://api.nexra.amakoragroup.com/api/connect/triggers/public_id" \
  -H "Content-Type: application/json" \
  -d '{}'

Response · 200

Accepted by a provider-scheme trigger, or a repeat of an event already received (duplicate: true).

Errors: 400, 401, 404, 413, 429, 500. Error shape

Lifecycle

Pause, resume, suspend, delete and restore integrations, flows and connections.

DELETE/api/console/connect/integrations/{integrationId}

Delete an integration

Moves the integration to Recently deleted. It can be restored until purgeAfter.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Request body · application/json

Request body
Field	Type	Description
confirmation	string	The item's name, typed to confirm. Required when the item has live flows.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/integrations/{integrationId}", {
    params: { path: { integrationId: "integration_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
deletedrequired	true
namerequired	string
purgeAfterrequired	string	When the item is removed for good. Restore it before then.
retentionDaysrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/lifecycle/permissions

What your role can do

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/lifecycle/permissions"),
);

Response · 200

Success.

Response fields
Field	Type	Description
pauserequired	boolean
suspendrequired	boolean
deleterequired	boolean
restorerequired	boolean
editrequired	boolean
rolerequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/recently-deleted

List recently deleted items

Integrations and flows deleted within the retention period, which can still be restored.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/recently-deleted"),
);

Response · 200

Success.

Response fields
Field	Type	Description
retentionDaysrequired	integer
canRestorerequired	boolean
integrationsrequired	array of object
flowsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations/{integrationId}/pause

Pause an integration

Stops new runs of every flow in the integration until it is resumed.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/pause", {
    params: { path: { integrationId: "integration_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations/{integrationId}/resume

Resume an integration

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/resume", {
    params: { path: { integrationId: "integration_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations/{integrationId}/suspend

Suspend an integration

A stronger stop than pausing, for incidents. Lifting it needs the integration's name typed to confirm.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Request body · application/json

Request body
Field	Type	Description
reasonrequired	string	Why it is suspended. Kept in the audit trail.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/suspend", {
    params: { path: { integrationId: "integration_id" } },
    body: {
      "reason": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations/{integrationId}/lift-suspension

Lift an integration's suspension

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Request body · application/json

Request body
Field	Type	Description
confirmationrequired	string	The item's name, typed to confirm.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/lift-suspension", {
    params: { path: { integrationId: "integration_id" } },
    body: {
      "confirmation": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/integrations/{integrationId}/restore

Restore a deleted integration

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
integrationId (path)required	string	The integration id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/integrations/{integrationId}/restore", {
    params: { path: { integrationId: "integration_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
projectIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string	Stored status, for example `draft`, `active` or `archived`.
businessOwnerUserIdrequired	string \| null
technicalOwnerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
archivedAtrequired	string \| null	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
suspendedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
lifecycle	object
flows	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/pause

Pause a flow

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/pause", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string
activeVersionIdrequired	string \| null	The published version runs use.
ownerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
versions	array of object
lifecycle	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/resume

Resume a flow

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/resume", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string
activeVersionIdrequired	string \| null	The published version runs use.
ownerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
versions	array of object
lifecycle	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

DELETE/api/console/connect/flows/{flowId}

Delete a flow

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Request body · application/json

Request body
Field	Type	Description
confirmation	string	The item's name, typed to confirm. Required when the item has live flows.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/flows/{flowId}", {
    params: { path: { flowId: "flow_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
deletedrequired	true
namerequired	string
purgeAfterrequired	string	When the item is removed for good. Restore it before then.
retentionDaysrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/flows/{flowId}/restore

Restore a deleted flow

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
flowId (path)required	string	The flow id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/flows/{flowId}/restore", {
    params: { path: { flowId: "flow_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
integrationIdrequired	string
namerequired	string
slugrequired	string
descriptionrequired	string \| null
statusrequired	string
activeVersionIdrequired	string \| null	The published version runs use.
ownerUserIdrequired	string \| null
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.
pausedAtrequired	string \| null	ISO 8601 date and time.
deletedAtrequired	string \| null	ISO 8601 date and time.
versions	array of object
lifecycle	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/connections/{connectionId}/lifecycle

Get a connection's suspension state

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/connections/{connectionId}/lifecycle", {
    params: { path: { connectionId: "connection_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
suspendedrequired	boolean
suspendedAtrequired	string \| null	ISO 8601 date and time.
suspendedByrequired	object \| null
suspensionReasonrequired	string \| null
summaryrequired	string \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/connections/{connectionId}/suspend

Suspend a connection

Stops every flow from using this connection until the suspension is lifted.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Request body · application/json

Request body
Field	Type	Description
reasonrequired	string	Why it is suspended. Kept in the audit trail.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/connections/{connectionId}/suspend", {
    params: { path: { connectionId: "connection_id" } },
    body: {
      "reason": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
suspendedrequired	boolean
suspendedAtrequired	string \| null	ISO 8601 date and time.
suspendedByrequired	object \| null
suspensionReasonrequired	string \| null
summaryrequired	string \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/connections/{connectionId}/lift-suspension

Lift a connection's suspension

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (path)required	string	The connection id.

Request body · application/json

Request body
Field	Type	Description
confirmationrequired	string	The item's name, typed to confirm.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/connections/{connectionId}/lift-suspension", {
    params: { path: { connectionId: "connection_id" } },
    body: {
      "confirmation": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
suspendedrequired	boolean
suspendedAtrequired	string \| null	ISO 8601 date and time.
suspendedByrequired	object \| null
suspensionReasonrequired	string \| null
summaryrequired	string \| null
canrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

Reconciliation

Compare two sources of records, match them and review the items that need a person.

GET/api/console/connect/reconciliation-options

List what can be reconciled

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
environment (query)	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliation-options"),
);

Response · 200

Success.

Response fields
Field	Type	Description
environmentrequired	string
appsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliation-templates

List reconciliation templates

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliation-templates"),
);

Response · 200

Success.

Response fields
Field	Type	Description
templatesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliations

List reconciliations

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
environment (query)	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliations"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
reconciliationsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliations

Create a reconciliation

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
namerequired	string
environment	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
sourcerequired	object
targetrequired	object
rules	object
schedule	object
timezone	string
lookbackDays	integer
description	string
templateKey	string
ownerId	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliations", {
    body: {
      "name": "string",
      "source": {
        "kind": "string",
        "recordTypes": [
          "string"
        ]
      },
      "target": {
        "kind": "string",
        "recordTypes": [
          "string"
        ]
      }
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
reconciliationrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliations/{id}

Get a reconciliation

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliations/{id}", {
    params: { path: { id: "id_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
reconciliationrequired	object
runsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/reconciliations/{id}

Update a reconciliation

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.

Request body · application/json

Request body
Field	Type	Description
name	string
description	string
rules	object
sourceRecordTypes	array of string
targetRecordTypes	array of string
schedule	object
timezone	string
ownerId	string
status	"active" \| "paused"

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/reconciliations/{id}", {
    params: { path: { id: "id_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
reconciliationrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliations/{id}/run

Run a reconciliation now

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliations/{id}/run", {
    params: { path: { id: "id_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
runrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliations/{id}/runs

List a reconciliation's runs

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliations/{id}/runs", {
    params: { path: { id: "id_id" } },
  }),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
runsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliations/{id}/candidates

Search records to match by hand

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.
side (query)	"source" \| "target"
search (query)	string	Text to look for, up to 100 characters.
limit (query)	integer	Up to 200. Default 50.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliations/{id}/candidates", {
    params: { path: { id: "id_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
siderequired	string
recordsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliations/{id}/uploads

Upload records as CSV

For a side that is an upload, such as a bank statement. Send the CSV text as content in a JSON body. A contribution reconciliation takes side schedule, payment, custodian or posting, and Excel files base64-encoded with format xlsx; RSA PINs are kept only as a fingerprint and their last four characters.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.

Request body · application/json

Request body
Field	Type	Description
contentrequired	string	The CSV text, or an Excel file base64-encoded.
side	"source" \| "target" \| "schedule" \| "payment" \| "custodian" \| "posting"
format	"csv" \| "xlsx"
recordType	string
currency	string
dateOrder	"day_first" \| "month_first"
columns	object	Which CSV column holds `date`, `amount`, `reference` and so on.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliations/{id}/uploads", {
    params: { path: { id: "id_id" } },
    body: {
      "content": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
rowCountrequired	integer
addedrequired	integer
alreadyUploadedrequired	integer
problemsrequired	array of object
messagerequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliations/{id}/sample

Load the pension sample

Test mode only: loads synthetic files (three made-up employers over the last two months, with every kind of exception) into a contribution reconciliation.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
id (path)required	string	The reconciliation id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliations/{id}/sample", {
    params: { path: { id: "id_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
loadedrequired	object
periodsrequired	array of string
messagerequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliation-runs/{runId}

Get a reconciliation run

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
runId (path)required	string	The run id.
status (query)	string	Only lines with this status.
limit (query)	integer	How many to return, up to 500. Default 100.
offset (query)	integer	How many to skip.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliation-runs/{runId}", {
    params: { path: { runId: "run_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
runrequired	object
totalrequired	integer
linesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliation-review

List items to review

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`open` (default), `pending`, `done` or `all`.
reconciliationId (query)	string	Only this reconciliation.
environment (query)	"sandbox" \| "production"	`sandbox` is Test mode; `production` is live.
limit (query)	integer	How many to return, up to 200. Default 50.
offset (query)	integer	How many to skip.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliation-review"),
);

Response · 200

Success.

Response fields
Field	Type	Description
totalrequired	integer
itemsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/reconciliation-review/{itemId}

Get an item to review

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
itemId (path)required	string	The item id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/reconciliation-review/{itemId}", {
    params: { path: { itemId: "item_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
itemrequired	object
actionsrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliation-review/{itemId}/accept

Accept the suggested match

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
itemId (path)required	string	The item id.

Request body · application/json

Request body
Field	Type	Description
note	string
chosenExternalId	string	When several records could match, the one to match (one of the suggestion's externalIds). Required for those items.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliation-review/{itemId}/accept", {
    params: { path: { itemId: "item_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
matchIdrequired	string
explanationrequired	string \| null
itemrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliation-review/{itemId}/match

Match records by hand

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
itemId (path)required	string	The item id.

Request body · application/json

Request body
Field	Type	Description
sourceExternalIdsrequired	array of string
targetExternalIdsrequired	array of string
note	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliation-review/{itemId}/match", {
    params: { path: { itemId: "item_id" } },
    body: {
      "sourceExternalIds": [
        "string"
      ],
      "targetExternalIds": [
        "string"
      ]
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
matchIdrequired	string
explanationrequired	string \| null
itemrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliation-review/{itemId}/explain

Mark an item explained

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
itemId (path)required	string	The item id.

Request body · application/json

Request body
Field	Type	Description
category	"known_fee" \| "timing" \| "not_from_this_provider" \| "duplicate" \| "rounding" \| "other"
note	string	Required (3 or more characters) when the category is `other`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliation-review/{itemId}/explain", {
    params: { path: { itemId: "item_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
itemrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliation-review/{itemId}/reopen

Reopen an item

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
itemId (path)required	string	The item id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliation-review/{itemId}/reopen", {
    params: { path: { itemId: "item_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
itemrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliation-review/{itemId}/adjustment

Propose an adjustment

Proposes a payment, fee or refund entry to fix a difference. It goes through approval before anything is written.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
itemId (path)required	string	The item id.

Request body · application/json

Request body
Field	Type	Description
kindrequired	"record_payment" \| "record_fee" \| "record_refund" \| "record_fx_difference"
valuesrequired	object
reasonrequired	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliation-review/{itemId}/adjustment", {
    params: { path: { itemId: "item_id" } },
    body: {
      "kind": "record_payment",
      "values": {},
      "reason": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
statusrequired	string
actionIdrequired	string \| null
summaryrequired	string \| null
messagerequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/reconciliation-matches/{matchId}/undo

Undo a match

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
matchId (path)required	string	The match id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/reconciliation-matches/{matchId}/undo", {
    params: { path: { matchId: "match_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
matchIdrequired	string
statusrequired	"undone"

Errors: 400, 401, 403, 404, 429, 500. Error shape

Pensions

Employer statements from contribution reconciliations, digital onboarding and benefit case packs with their timelines and sealed export, and the returns calendar. People decide every case and file every return.

GET/api/console/connect/pensions/contributions/{reconciliationId}/employers

List employers with open contribution exceptions

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
reconciliationId (path)required	string	A contribution reconciliation's id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/pensions/contributions/{reconciliationId}/employers", {
    params: { path: { reconciliationId: "reconciliation_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
employersrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/pensions/contributions/{reconciliationId}/statements

Make an employer statement of discrepancies

Puts every open exception for one employer on a statement that waits for a second person's approval before anything sends it. Members appear by the last four characters of their RSA PIN.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
reconciliationId (path)required	string	A contribution reconciliation's id.

Request body · application/json

Request body
Field	Type	Description
employerKeyrequired	string
note	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/pensions/contributions/{reconciliationId}/statements", {
    params: { path: { reconciliationId: "reconciliation_id" } },
    body: {
      "employerKey": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
statusrequired	"pending_approval"

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/pensions/packs

List the case packs

The digital onboarding and benefit application packs: each checklist, the default timelines and how identity is checked.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/pensions/packs"),
);

Response · 200

Success.

Response fields
Field	Type	Description
packsrequired	array of object
timelinesrequired	object
identityrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/pensions/cases

List pension cases

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
kind (query)	string	onboarding, retirement, withdrawal_25 or death_benefit.
status (query)	string	in_review, approved or returned.
evidenceMatrixId (query)	string	Only the case behind this evidence matrix.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/pensions/cases"),
);

Response · 200

Success.

Response fields
Field	Type	Description
casesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/pensions/cases

Open a case pack

Documents are sent as their file name, size and SHA-256 fingerprint; the files stay with you. The identity check is recorded as its outcome, never the NIN. The evidence goes to a second person for review.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
kindrequired	"onboarding" \| "retirement" \| "withdrawal_25" \| "death_benefit"
referencerequired	string
memberPin	string	Only its last four characters are kept.
documents	array of object
identityCheck	object
notes	object
timelines	object

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/pensions/cases", {
    body: {
      "kind": "onboarding",
      "reference": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
kindrequired	"onboarding" \| "retirement" \| "withdrawal_25" \| "death_benefit"
referencerequired	string	Your own case reference. Never an RSA PIN or NIN.
memberrequired	string \| null	The member by the last four characters of the RSA PIN.
statusrequired	"in_review" \| "approved" \| "returned" \| "closed"
nextSteprequired	string
evidenceMatrixIdrequired	string
documentsrequired	array of object
obligationsrequired	array of object
sealedAtrequired	string \| null
sealHashrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/pensions/cases/{caseId}

Get a pension case

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
caseId (path)required	string	The case id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/pensions/cases/{caseId}", {
    params: { path: { caseId: "case_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
kindrequired	"onboarding" \| "retirement" \| "withdrawal_25" \| "death_benefit"
referencerequired	string	Your own case reference. Never an RSA PIN or NIN.
memberrequired	string \| null	The member by the last four characters of the RSA PIN.
statusrequired	"in_review" \| "approved" \| "returned" \| "closed"
nextSteprequired	string
evidenceMatrixIdrequired	string
documentsrequired	array of object
obligationsrequired	array of object
sealedAtrequired	string \| null
sealHashrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/pensions/cases/{caseId}/decision

Approve a case pack or send it back

A different member from the one who opened it decides. Approval opens the next obligation: payment, the Commission's approval, or the registration.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
caseId (path)required	string	The case id.

Request body · application/json

Request body
Field	Type	Description
decisionrequired	"approved" \| "rejected"
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/pensions/cases/{caseId}/decision", {
    params: { path: { caseId: "case_id" } },
    body: {
      "decision": "approved"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
kindrequired	"onboarding" \| "retirement" \| "withdrawal_25" \| "death_benefit"
referencerequired	string	Your own case reference. Never an RSA PIN or NIN.
memberrequired	string \| null	The member by the last four characters of the RSA PIN.
statusrequired	"in_review" \| "approved" \| "returned" \| "closed"
nextSteprequired	string
evidenceMatrixIdrequired	string
documentsrequired	array of object
obligationsrequired	array of object
sealedAtrequired	string \| null
sealHashrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/pensions/cases/{caseId}/regulator-approval

Record the Commission's approval

For death benefit claims: after a person submits the claim and the Commission approves it, record its reference to start the payment clock.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
caseId (path)required	string	The case id.

Request body · application/json

Request body
Field	Type	Description
referencerequired	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/pensions/cases/{caseId}/regulator-approval", {
    params: { path: { caseId: "case_id" } },
    body: {
      "reference": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
kindrequired	"onboarding" \| "retirement" \| "withdrawal_25" \| "death_benefit"
referencerequired	string	Your own case reference. Never an RSA PIN or NIN.
memberrequired	string \| null	The member by the last four characters of the RSA PIN.
statusrequired	"in_review" \| "approved" \| "returned" \| "closed"
nextSteprequired	string
evidenceMatrixIdrequired	string
documentsrequired	array of object
obligationsrequired	array of object
sealedAtrequired	string \| null
sealHashrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/pensions/cases/{caseId}/sealed-export

Export a sealed case

The evidence, each document's SHA-256, who opened, reviewed and decided the case with timestamps, and the IP address and device where captured, anchored to the governed evidence ledger and sealed with the SHA-256 of the body as canonical JSON.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
caseId (path)required	string	The case id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/pensions/cases/{caseId}/sealed-export", {
    params: { path: { caseId: "case_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
bodyrequired	object
sealrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/pensions/returns

List the returns calendar

The returns your compliance team entered, as obligations. Nexra ships no dates of its own.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/pensions/returns"),
);

Response · 200

Success.

Response fields
Field	Type	Description
returnsrequired	array of object
upcomingrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/pensions/returns

Add a return to the calendar

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
namerequired	string
dueDaterequired	string
recurrence	"none" \| "weekly" \| "monthly" \| "quarterly" \| "yearly"
ownerUserId	string
ownerTeam	string
reminderLeadDays	integer
note	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/pensions/returns", {
    body: {
      "name": "string",
      "dueDate": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/pensions/returns/examples

Add labelled examples to the calendar

Three examples, each labelled as an example to rename and re-date with the deadline your compliance team confirms.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/pensions/returns/examples"),
);

Response · 201

Success.

Response fields
Field	Type	Description
addedrequired	integer
returnsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

Event webhooks

Receive signed events about your workspace on your own HTTPS endpoints. See the webhooks section for every event payload.

GET/api/console/connect/event-webhooks/catalogue

List the events you can receive

Every event with a plain label, description and sample payload, grouped. The webhooks section of this document has each payload's schema.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/event-webhooks/catalogue"),
);

Response · 200

Success.

Response fields
Field	Type	Description
versionrequired	string
groupsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/event-webhooks

List event endpoints

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/event-webhooks"),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
namerequired	string
urlrequired	string
statusrequired	"active" \| "disabled"
moderequired	"test" \| "live"
healthStatusrequired	string
consecutiveFailuresrequired	integer
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
secretPrefixrequired	string
secretLast4required	string
eventTypesrequired	array of string
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/event-webhooks

Add an event endpoint

Returns the signing secret once. Test endpoints receive Test mode events; live endpoints receive live events.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
namerequired	string
urlrequired	string	An https URL on the public internet.
mode	"test" \| "live"
eventTypesrequired	array of string	Event types from the catalogue, for example `flow.run.failed`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/event-webhooks", {
    body: {
      "name": "string",
      "url": "string",
      "eventTypes": [
        "string"
      ]
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
endpointrequired	object
secretrequired	string	The signing secret. Shown once; store it safely.
revealPolicyrequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

PATCH/api/console/connect/event-webhooks/{endpointId}

Change an event endpoint

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endpointId (path)required	string	The endpoint id.

Request body · application/json

Request body
Field	Type	Description
name	string
url	string
status	"active" \| "disabled"
eventTypes	array of string	Event types from the catalogue, for example `flow.run.failed`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PATCH("/api/console/connect/event-webhooks/{endpointId}", {
    params: { path: { endpointId: "endpoint_id" } },
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
namerequired	string
urlrequired	string
statusrequired	"active" \| "disabled"
moderequired	"test" \| "live"
healthStatusrequired	string
consecutiveFailuresrequired	integer
lastSuccessAtrequired	string \| null	ISO 8601 date and time.
lastFailureAtrequired	string \| null	ISO 8601 date and time.
secretPrefixrequired	string
secretLast4required	string
eventTypesrequired	array of string
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

DELETE/api/console/connect/event-webhooks/{endpointId}

Turn an event endpoint off

Queued deliveries to it are cancelled.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endpointId (path)required	string	The endpoint id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.DELETE("/api/console/connect/event-webhooks/{endpointId}", {
    params: { path: { endpointId: "endpoint_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
statusrequired	"disabled"

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/event-webhooks/{endpointId}/secret/rotate

Rotate an endpoint's signing secret

Returns the new secret once. The old secret stops working at once.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endpointId (path)required	string	The endpoint id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/event-webhooks/{endpointId}/secret/rotate", {
    params: { path: { endpointId: "endpoint_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
endpointrequired	object
secretrequired	string	The signing secret. Shown once; store it safely.
revealPolicyrequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/event-webhooks/{endpointId}/test

Send a test event

Sends sandbox.test to the endpoint.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endpointId (path)required	string	The endpoint id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/event-webhooks/{endpointId}/test", {
    params: { path: { endpointId: "endpoint_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
endpointIdrequired	string
eventIdrequired	string
eventTyperequired	string
eventLabelrequired	string
moderequired	"test" \| "live"
statusrequired	string
statusLabelrequired	string
canResendrequired	boolean
attemptrequired	integer
maxAttemptsrequired	integer
nextAttemptAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
statusCoderequired	integer \| null
attemptsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/event-webhooks/{endpointId}/deliveries

List an endpoint's deliveries

The newest 100 deliveries with every attempt.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endpointId (path)required	string	The endpoint id.
status (query)	string	Only deliveries with this status, for example `failed`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/event-webhooks/{endpointId}/deliveries", {
    params: { path: { endpointId: "endpoint_id" } },
  }),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
endpointIdrequired	string
eventIdrequired	string
eventTyperequired	string
eventLabelrequired	string
moderequired	"test" \| "live"
statusrequired	string
statusLabelrequired	string
canResendrequired	boolean
attemptrequired	integer
maxAttemptsrequired	integer
nextAttemptAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
statusCoderequired	integer \| null
attemptsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/event-webhooks/{endpointId}/deliveries/{deliveryId}/resend

Send a delivery again

Same event id, with a fresh set of attempts.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
endpointId (path)required	string	The endpoint id.
deliveryId (path)required	string	The delivery id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/event-webhooks/{endpointId}/deliveries/{deliveryId}/resend", {
    params: { path: { endpointId: "endpoint_id", deliveryId: "delivery_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
endpointIdrequired	string
eventIdrequired	string
eventTyperequired	string
eventLabelrequired	string
moderequired	"test" \| "live"
statusrequired	string
statusLabelrequired	string
canResendrequired	boolean
attemptrequired	integer
maxAttemptsrequired	integer
nextAttemptAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
statusCoderequired	integer \| null
attemptsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

Research

Nexra for Professionals: read-only research from public registries (SEC EDGAR, Companies House, GDELT news, World Bank) and the person's own allowed tools. Plan, approve, follow progress, stop, and read a brief in which every number cites its source.

GET/api/console/research/runs

List research briefs

The signed-in person's research, newest first. Briefs are personal: other members don't see them.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
limit (query)	integer	1 to 50, default 20.
cursor (query)	string	The `nextCursor` from the previous page.
status (query)	string	Only this status, for example `completed`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/research/runs"),
);

Response · 200

Success.

A page of items. Pass nextCursor back as cursor for the next page.

Response fields
Field	Type	Description
itemsrequired	array of object
nextCursorrequired	string \| null

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/research/runs

Plan a research request

Turns a question into a plan: the subjects found in the registries, the exact reads it will make, and the steps it will use. Nothing is read from filings and no steps are used until the plan is approved. Read-only: research never writes to a connected tool. Answers 404 until research is switched on for the workspace.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
questionrequired	string
depth	"standard" \| "deep"	standard (25 steps) or deep (100 steps). Default standard.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/research/runs", {
    body: {
      "question": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
questionrequired	string
kindrequired	"brief" \| "compare"
depthrequired	"standard" \| "deep"
statusrequired	"planned" \| "approved" \| "running" \| "validating" \| "completed" \| "partial" \| "failed" \| "cancelled"
statusMessagerequired	string \| null
surfacerequired	"console" \| "mcp"
planrequired	object
progressrequired	array of object
readCountrequired	integer
stepsEstimatedrequired	integer	25 for a standard brief, 100 for a deep one.
stepsChargedrequired	integer
stopRequestedrequired	boolean
createdAtrequired	string	ISO 8601 date and time.
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
expiresAtrequired	string	ISO 8601 date and time.
output	object \| null	The validated brief, once the run has finished.
openUrlrequired	string \| null
saveUrlrequired	string \| null	Opens the brief in Nexra to save it (the person approves there).

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/research/runs/{runId}

Get research

Status and progress while it runs (poll every few seconds); the validated brief once it has finished.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
runId (path)required	string	The run id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/research/runs/{runId}", {
    params: { path: { runId: "run_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
questionrequired	string
kindrequired	"brief" \| "compare"
depthrequired	"standard" \| "deep"
statusrequired	"planned" \| "approved" \| "running" \| "validating" \| "completed" \| "partial" \| "failed" \| "cancelled"
statusMessagerequired	string \| null
surfacerequired	"console" \| "mcp"
planrequired	object
progressrequired	array of object
readCountrequired	integer
stepsEstimatedrequired	integer	25 for a standard brief, 100 for a deep one.
stepsChargedrequired	integer
stopRequestedrequired	boolean
createdAtrequired	string	ISO 8601 date and time.
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
expiresAtrequired	string	ISO 8601 date and time.
output	object \| null	The validated brief, once the run has finished.
openUrlrequired	string \| null
saveUrlrequired	string \| null	Opens the brief in Nexra to save it (the person approves there).

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/research/runs/{runId}/plan

Get a research plan

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
runId (path)required	string	The run id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/research/runs/{runId}/plan", {
    params: { path: { runId: "run_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
runIdrequired	string
statusrequired	string
questionrequired	string
planrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/research/runs/{runId}/approve

Approve and run a plan

Starts the approved plan as a background run. Optional edits: which reads stay on, and which candidate each ambiguous name is.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
runId (path)required	string	The run id.

Request body · application/json

Request body
Field	Type	Description
confirm	true
enabledReads	array of string
choices	object	Subject key to candidate index; -1 leaves the subject out.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/research/runs/{runId}/approve", {
    params: { path: { runId: "run_id" } },
    body: {},
  }),
);

Response · 202

Success.

Response fields
Field	Type	Description
idrequired	string
questionrequired	string
kindrequired	"brief" \| "compare"
depthrequired	"standard" \| "deep"
statusrequired	"planned" \| "approved" \| "running" \| "validating" \| "completed" \| "partial" \| "failed" \| "cancelled"
statusMessagerequired	string \| null
surfacerequired	"console" \| "mcp"
planrequired	object
progressrequired	array of object
readCountrequired	integer
stepsEstimatedrequired	integer	25 for a standard brief, 100 for a deep one.
stepsChargedrequired	integer
stopRequestedrequired	boolean
createdAtrequired	string	ISO 8601 date and time.
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
expiresAtrequired	string	ISO 8601 date and time.
output	object \| null	The validated brief, once the run has finished.
openUrlrequired	string \| null
saveUrlrequired	string \| null	Opens the brief in Nexra to save it (the person approves there).
pollAfterSecondsrequired	integer

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/research/runs/{runId}/stop

Stop research

A run that hasn't started is cancelled at once and uses no steps. A running one stops before its next read and uses only the share of reads that happened.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
runId (path)required	string	The run id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/research/runs/{runId}/stop", {
    params: { path: { runId: "run_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
questionrequired	string
kindrequired	"brief" \| "compare"
depthrequired	"standard" \| "deep"
statusrequired	"planned" \| "approved" \| "running" \| "validating" \| "completed" \| "partial" \| "failed" \| "cancelled"
statusMessagerequired	string \| null
surfacerequired	"console" \| "mcp"
planrequired	object
progressrequired	array of object
readCountrequired	integer
stepsEstimatedrequired	integer	25 for a standard brief, 100 for a deep one.
stepsChargedrequired	integer
stopRequestedrequired	boolean
createdAtrequired	string	ISO 8601 date and time.
startedAtrequired	string \| null	ISO 8601 date and time.
completedAtrequired	string \| null	ISO 8601 date and time.
expiresAtrequired	string	ISO 8601 date and time.
output	object \| null	The validated brief, once the run has finished.
openUrlrequired	string \| null
saveUrlrequired	string \| null	Opens the brief in Nexra to save it (the person approves there).

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/research/runs/{runId}/check-claims

Check text against a brief's facts

Every number in the text must match a fact or calculation cited in the same sentence.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
runId (path)required	string	The run id.

Request body · application/json

Request body
Field	Type	Description
textrequired	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/research/runs/{runId}/check-claims", {
    params: { path: { runId: "run_id" } },
    body: {
      "text": "string"
    },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
claimsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/research/sources

List research sources

The public sources with their shared limits and licences, and the person's connected tools with whether each is allowed.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/research/sources"),
);

Response · 200

Success.

Response fields
Field	Type	Description
sourcesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/research/policy

Get research source settings

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/research/policy"),
);

Response · 200

Success.

Response fields
Field	Type	Description
versionrequired	integer
allowedPublicSourcesrequired	array of string
allowedConnectionIdsrequired	array of string
maxReadsPerRunrequired	integer
retentionDaysrequired	integer
publicSourcesrequired	array of object
connectionsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

PUT/api/console/research/policy

Change research source settings

Owners and admins only. Connected tools are off until allowed here.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
allowedPublicSources	array of "sec-edgar" \| "companies-house" \| "gdelt" \| "world-bank"
allowedConnectionIds	array of string
maxReadsPerRun	integer
retentionDays	30 \| 90 \| 365

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.PUT("/api/console/research/policy", {
    body: {},
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
versionrequired	integer
allowedPublicSourcesrequired	array of string
allowedConnectionIdsrequired	array of string
maxReadsPerRunrequired	integer
retentionDaysrequired	integer
publicSourcesrequired	array of object
connectionsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/research/assistants

List connected AI assistants

The person's AI assistants signed in to the personal MCP server (/mcp/pro).

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/research/assistants"),
);

Response · 200

Success.

Response fields
Field	Type	Description
assistantsrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/research/assistants/{grantId}/disconnect

Disconnect an AI assistant

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
grantId (path)required	string	The grant id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/research/assistants/{grantId}/disconnect", {
    params: { path: { grantId: "grant_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
disconnectedrequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

Approvals

Read and decide approval requests raised by governed actions and releases.

GET/api/console/approvals

List approval requests

Newest first, up to 100. Approvers see every request; others see their own.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	For example `pending`, `approved` or `rejected`.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/approvals"),
);

Response · 200

Success.

A list, newest first, capped as described above.

Response fields
Field	Type	Description
idrequired	string
actionrequired	string
resourceTyperequired	string	`connector_action`, `mcp_tool` or `credential_action`.
resourceIdrequired	string \| null
environmentrequired	string \| null
statusrequired	string	`pending`, `approved`, `rejected`, `expired`, `cancelled`, `executing`, `succeeded` or `failed`.
requiredApprovalsrequired	integer
requiredApproverRolerequired	string \| null
expiresAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/approvals/{approvalId}/decision

Approve or reject a request

You cannot approve your own request.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
approvalId (path)required	string	The approval id.

Request body · application/json

Request body
Field	Type	Description
decisionrequired	"approved" \| "rejected"
reasonrequired	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/approvals/{approvalId}/decision", {
    params: { path: { approvalId: "approval_id" } },
    body: {
      "decision": "approved",
      "reason": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
actionrequired	string
resourceTyperequired	string	`connector_action`, `mcp_tool` or `credential_action`.
resourceIdrequired	string \| null
environmentrequired	string \| null
statusrequired	string	`pending`, `approved`, `rejected`, `expired`, `cancelled`, `executing`, `succeeded` or `failed`.
requiredApprovalsrequired	integer
requiredApproverRolerequired	string \| null
expiresAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/approvals/{approvalId}/cancel

Cancel your own request

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
approvalId (path)required	string	The approval id.

Request body · application/json

Request body
Field	Type	Description
reason	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/approvals/{approvalId}/cancel", {
    params: { path: { approvalId: "approval_id" } },
    body: {},
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
idrequired	string
actionrequired	string
resourceTyperequired	string	`connector_action`, `mcp_tool` or `credential_action`.
resourceIdrequired	string \| null
environmentrequired	string \| null
statusrequired	string	`pending`, `approved`, `rejected`, `expired`, `cancelled`, `executing`, `succeeded` or `failed`.
requiredApprovalsrequired	integer
requiredApproverRolerequired	string \| null
expiresAtrequired	string \| null	ISO 8601 date and time.
createdAtrequired	string	ISO 8601 date and time.
updatedAtrequired	string	ISO 8601 date and time.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/approvals

List governed write approvals

Approvals for writes to connected systems that a policy holds for review.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	For example `pending`.
connectionId (query)	string	Only this connection.
riskTier (query)	string	`R0` to `R4`.
q (query)	string	Text to look for.
cursor (query)	string	`nextCursor` from the previous page.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/approvals"),
);

Response · 200

Success.

A page of items. Pass nextCursor back as cursor for the next page.

Response fields
Field	Type	Description
itemsrequired	array of object
nextCursorrequired	string \| null	Pass as `cursor` to get the next page. `null` on the last page.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/approvals/{approvalId}

Get a governed write approval

What would be written, why it was held, and the binding.digest to send back with your decision.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
approvalId (path)required	string	The approval id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/approvals/{approvalId}", {
    params: { path: { approvalId: "approval_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string
statusrequired	string
requestedAtrequired	string	ISO 8601 date and time.
expiresAtrequired	string \| null	ISO 8601 date and time.
actionrequired	object
bindingrequired	object	Send `digest` back as `reviewedDigest` when you decide.
canDeciderequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/governance/approvals/{approvalId}/decision

Decide a governed write approval

reviewedDigest must equal the approval's binding.digest, so you decide exactly what you reviewed. A mismatch answers 409 approval_digest_mismatch.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
approvalId (path)required	string	The approval id.

Request body · application/json

Request body
Field	Type	Description
decisionrequired	"approve" \| "reject"
reviewedDigestrequired	string
note	string	Required (3 or more characters) to reject.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/governance/approvals/{approvalId}/decision", {
    params: { path: { approvalId: "approval_id" } },
    body: {
      "decision": "approve",
      "reviewedDigest": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
approvalrequired	object
resume	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/governance/approvals/{approvalId}/request-again

Ask again after an approval expired

When a governed write's approval expired before anyone decided, this retries the flow record so a new approval opens and the approvers are told again. Answers 409 when the approval has not expired or nothing waits on it any more.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
approvalId (path)required	string	The approval id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/governance/approvals/{approvalId}/request-again", {
    params: { path: { approvalId: "approval_id" } },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
approvalrequired	object
resume	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

Governance

Read governance policies, grants, evidence and measures.

GET/api/console/connect/governance/evidence

List governance evidence

The tamper-evident record of governed decisions and results, 50 per page.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
eventType (query)	string	For example `decision` or `result`.
actionId (query)	string	Only this action.
connectionId (query)	string	Only this connection.
from (query)	string	ISO date or time.
to (query)	string	ISO date or time.
cursor (query)	string	`nextCursor` from the previous page.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/evidence"),
);

Response · 200

Success.

A page of items. Pass nextCursor back as cursor for the next page.

Response fields
Field	Type	Description
itemsrequired	array of object
nextCursorrequired	string \| null	Pass as `cursor` to get the next page. `null` on the last page.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/evidence/verify

Verify the evidence chain

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/evidence/verify"),
);

Response · 200

Success.

Response fields
Field	Type	Description
validrequired	boolean
checkedrequired	integer
brokenAtSequencerequired	integer \| null
verifiedAtrequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/evidence/export

Export evidence

A JSON file of evidence entries with the hash chain, for auditors.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
from (query)	string	ISO date or time.
to (query)	string	ISO date or time.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/evidence/export"),
);

Response · 200

Success.

Response fields
Field	Type	Description
formatrequired	string
exportedAtrequired	string
entriesrequired	array of object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/measures

Get governance measures

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
window (query)	"7d" \| "30d"

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/measures"),
);

Response · 200

Success.

Response fields
Field	Type	Description
windowrequired	string
writesrequired	object
approvalsrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/actions/{actionId}/timeline

Get one action's timeline

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
actionId (path)required	string	The action id.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/actions/{actionId}/timeline", {
    params: { path: { actionId: "action_id" } },
  }),
);

Response · 200

Success.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/policies

List policies

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
connectionId (query)	string	Only this connection.
limit (query)	integer	Up to 500.
cursor (query)	string	`nextCursor` from the previous page.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/policies"),
);

Response · 200

Success.

A page of items. Pass nextCursor back as cursor for the next page.

Response fields
Field	Type	Description
itemsrequired	array of object
nextCursorrequired	string \| null	Pass as `cursor` to get the next page. `null` on the last page.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/principals

List who can be granted access

Flows and app credentials that can be given write grants. No key material is returned.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
type (query)	string	`flow`, `mcp_credential` or `api_credential`.
q (query)	string	Text to look for.
limit (query)	integer	Up to 500. Default 200.
cursor (query)	string	`nextCursor` from the previous page.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/principals"),
);

Response · 200

Success.

A page of items. Pass nextCursor back as cursor for the next page.

Response fields
Field	Type	Description
itemsrequired	array of object
nextCursorrequired	string \| null	Pass as `cursor` to get the next page. `null` on the last page.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/grants

List access grants

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
status (query)	string	`active`, `expired` or `revoked`.
principalType (query)	string	Only this kind of principal.
principalId (query)	string	Only this principal.
connectionId (query)	string	Only this connection.
limit (query)	integer	Up to 500.
cursor (query)	string	`nextCursor` from the previous page.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/grants"),
);

Response · 200

Success.

A page of items. Pass nextCursor back as cursor for the next page.

Response fields
Field	Type	Description
itemsrequired	array of object
nextCursorrequired	string \| null	Pass as `cursor` to get the next page. `null` on the last page.

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/governance/settings

Get governance settings

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/governance/settings"),
);

Response · 200

Success.

Response fields
Field	Type	Description
requireGrantsForWritesrequired	boolean
singlePersonApprovalrequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/governance/decisions/explain

Explain what a policy would decide

Says whether a write would be allowed, held for approval or denied, and why. Nothing is written.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Request body · application/json

Request body
Field	Type	Description
connectionIdrequired	string
operationKeyrequired	string
input	object
principalType	string
principalId	string

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/governance/decisions/explain", {
    body: {
      "connectionId": "string",
      "operationKey": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
decisionrequired	string
rulerequired	string \| null
reasonrequired	string

Errors: 400, 401, 403, 404, 429, 500. Error shape

Templates

Ready-made integrations you can install into a workspace.

GET/api/console/connect/templates

List templates

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/templates"),
);

Response · 200

Success.

Response fields
Field	Type	Description
keyrequired	string
namerequired	string
descriptionrequired	string
categoryrequired	string
businessPurposerequired	string \| null
requiredConnectorsrequired	array of string
statusrequired	string
installablerequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

GET/api/console/connect/templates/{templateKey}

Get a template

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
templateKey (path)required	string	The template key.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.GET("/api/console/connect/templates/{templateKey}", {
    params: { path: { templateKey: "templateKey_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
keyrequired	string
namerequired	string
descriptionrequired	string
categoryrequired	string
businessPurposerequired	string \| null
requiredConnectorsrequired	array of string
statusrequired	string
installablerequired	boolean

Errors: 400, 401, 403, 404, 429, 500. Error shape

POST/api/console/connect/templates/{templateKey}/install

Install a template

Creates an integration and its flows from the template.

Access token and workspace

Send Authorization: Bearer <token> and X-Workspace-Id. The token acts with your own role.

Parameters

Parameters
Field	Type	Description
templateKey (path)required	string	The template key.

Request body · application/json

Request body
Field	Type	Description
projectIdrequired	string
name	string
choices	object	For templates with choices: choice key to option.
connections	object	Connector key to the connection id to use.
applyApprovalPolicies	boolean	Also save the template's approval rules on the supplied connections. Defaults to false; when false they are returned as suggestions.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient(); // NEXRA_TOKEN and NEXRA_WORKSPACE_ID
const result = unwrap(
  await nexra.POST("/api/console/connect/templates/{templateKey}/install", {
    params: { path: { templateKey: "templateKey_id" } },
    body: {
      "projectId": "string"
    },
  }),
);

Response · 201

Success.

Response fields
Field	Type	Description
integrationrequired	object
flowrequired	object
flowVersionrequired	object

Errors: 400, 401, 403, 404, 429, 500. Error shape

Catalogue

Public connector catalogue, service uptime and this API description. No sign-in needed.

GET/api/public/connect/connectors

List connectors

Every connector with its operations, authentication and limits. No sign-in needed.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/api/public/connect/connectors"),
);

Response · 200

Success.

Response fields
Field	Type	Description
coveragerequired	object
connectorsrequired	array of object

Errors: 404, 429, 500. Error shape

GET/api/public/connect/connectors/{connectorKey}

Get a connector

No sign-in needed

Anyone can call this operation.

Parameters

Parameters
Field	Type	Description
connectorKey (path)required	string	The connector key.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/api/public/connect/connectors/{connectorKey}", {
    params: { path: { connectorKey: "connectorKey_id" } },
  }),
);

Response · 200

Success.

Response fields
Field	Type	Description
keyrequired	string
namerequired	string
vendorrequired	string \| null
categoryrequired	string
categoryLabelrequired	string
summaryrequired	string
statusrequired	string
implementedrequired	boolean
authentication	object
documentationUrlrequired	string \| null
limitationsrequired	array of string
operationsrequired	array of object

Errors: 404, 429, 500. Error shape

GET/api/public/connect/coverage

Get connector coverage

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/api/public/connect/coverage"),
);

Response · 200

Success.

Errors: 404, 429, 500. Error shape

GET/api/public/openapi.json

Get this API description

This OpenAPI 3.1 document.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/api/public/openapi.json"),
);

Response · 200

Success.

Response fields
Field	Type	Description
openapirequired	string
inforequired	object

Errors: 404, 429, 500. Error shape

GET/api/public/status/uptime

Get uptime history

Daily uptime for the last 90 days, measured by synthetic checks that run every minute outside the API. Only days with measurements are listed. No sign-in needed.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/api/public/status/uptime"),
);

Response · 200

Success.

Response fields
Field	Type	Description
generatedAtrequired	string
windowDaysrequired	integer
daysMeasuredrequired	integer
measuredFromrequired	string \| null
uptimePercentrequired	number \| null
methodrequired	string
targetsrequired	array of object
outagesrequired	array of object
incidentsrequired	array of object

Errors: 404, 429, 500. Error shape

Company data

Ask questions about your business's own data, and read the Leadership summary, as the person who signed in. Read only, cited and logged. These need an OAuth access token that acts for a person in a read access group; workspace API keys and service credentials are refused.

POST/api/connect/v1/company/ask

Ask a question about company data

Asks one question across the systems the signed-in person's read access group can read, and returns a cited answer. Read only: nothing can be created, changed, sent or paid. Every number is cited to a read or a calculation Nexra did in code, and uncited numbers are removed. Personal details are hidden when the group says so. Use an OAuth access token that acts for a person who signed in themselves (the same token as /mcp, with company:read); workspace API keys and client-credentials tokens get 403. Each person can ask 10 questions in 10 minutes across the console, MCP and this API, and every question is in the read access log with origin api.

MCP access token

An OAuth access token for the MCP endpoint. MCP clients get one through the sign-in metadata.

Request body · application/json

Request body
Field	Type	Description
questionrequired	string
groupId	string	Which of your read access groups to ask under. Defaults to your first.
followUpOf	string	The `id` of your earlier answer this question follows up.

Examples

curl

curl -X POST "https://api.nexra.amakoragroup.com/api/connect/v1/company/ask" \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"question":"How much did we collect last week compared with the week before?"}'

Response · 200

Success.

Response fields
Field	Type	Description
idrequired	string	The read access log entry. Pass it as `followUpOf` to ask a follow-up.
questionrequired	string
originrequired	"api"
grouprequired	object
statusrequired	"answered" \| "partial" \| "refused" \| "failed"
answerrequired	object
readsrequired	array of object
summaryrequired	string
textrequired	string	The answer as plain text with its citations, ready to show in a chat.
durationMsrequired	integer
readOnlyrequired	true
loggedrequired	true

Errors: 400, 401, 403, 429, 500, 503. Error shape

GET/api/connect/v1/company/leadership

Get the Leadership summary

Today's Leadership summary for a member of a read access group with Insights on: headcount and who's in today by team (counts only), cash in and out yesterday and over 14 days, and money Nexra moved yesterday. The same OAuth rules as asking: a person's own sign-in only. Every view is logged with origin api.

MCP access token

An OAuth access token for the MCP endpoint. MCP clients get one through the sign-in metadata.

Examples

curl

curl -X GET "https://api.nexra.amakoragroup.com/api/connect/v1/company/leadership" \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN"

Response · 200

Success.

Response fields
Field	Type	Description
visiblerequired	true
grouprequired	object
attendancerequired	object
cashrequired	object \| null
moneyMovedrequired	object
calculatedAtrequired	string
readOnlyrequired	true
loggedrequired	true
namesIncludedrequired	false

Errors: 400, 401, 403, 429, 500, 503. Error shape

MCP

The Model Context Protocol endpoint that exposes your published integrations as tools to AI agents.

POST/mcp

Send an MCP message

The MCP Streamable HTTP endpoint. Send one JSON-RPC 2.0 message per request: initialize, then tools/list and tools/call. Published integrations appear as tools. MCP clients discover sign-in from /.well-known/oauth-protected-resource/mcp.

MCP access token

An OAuth access token for the MCP endpoint. MCP clients get one through the sign-in metadata.

Parameters

Parameters
Field	Type	Description
Mcp-Session-Id (header)	string	The session id from the `initialize` answer. Required after initialising.
MCP-Protocol-Version (header)	string	The MCP protocol version you negotiated.

Request body · application/json

Request body
Field	Type	Description
jsonrpcrequired	"2.0"
id	string \| number
methodrequired	string
params	object

Examples

curl

curl -X POST "https://api.nexra.amakoragroup.com/mcp" \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list"}'

Response · 200

Success.

Response fields
Field	Type	Description
jsonrpcrequired	"2.0"
idrequired	string \| number \| null \| null
result	object
error	object

Errors: 400, 401, 429, 500. Error shape

DELETE/mcp

End an MCP session

MCP access token

An OAuth access token for the MCP endpoint. MCP clients get one through the sign-in metadata.

Parameters

Parameters
Field	Type	Description
Mcp-Session-Id (header)required	string	The session to end.

Examples

curl

curl -X DELETE "https://api.nexra.amakoragroup.com/mcp" \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN"

Response · 204

Success.

Errors: 400, 401, 429, 500. Error shape

GET/.well-known/oauth-protected-resource/mcp

Get MCP sign-in metadata

OAuth protected-resource metadata (RFC 9728) for the MCP endpoint: which authorisation server issues tokens and which scopes exist.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/.well-known/oauth-protected-resource/mcp"),
);

Response · 200

Success.

Response fields
Field	Type	Description
resourcerequired	string
authorization_servers	array of string
scopes_supported	array of string
bearer_methods_supported	array of string

Errors: 404, 429, 500. Error shape

GET/.well-known/oauth-protected-resource

Get sign-in metadata

The same metadata at the default location.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/.well-known/oauth-protected-resource"),
);

Response · 200

Success.

Response fields
Field	Type	Description
resourcerequired	string
authorization_servers	array of string
scopes_supported	array of string
bearer_methods_supported	array of string

Errors: 404, 429, 500. Error shape

POST/api/gateway/tools/{name}

Call a Gateway tool over REST

The Gateway's REST transport: the same published tools, scopes, rate limits and approval policies as the MCP endpoint, without an MCP session. Send the MCP OAuth access token as Authorization: Bearer <token>. The answer is the MCP tool result: content entries whose text is JSON. Approvals. A sensitive tool or a governed write can answer { "status": "approval_required", "approval": { "id", "status", "expiresAt" }, "recoveryAction" } instead of running. Nothing has run yet. A different authorised workspace member approves it; then send the same request again, with the same arguments and idempotency key, and meta["nexra/approvalRequestId"] set to the approval id. Approvals expire, are bound to the exact request and are used once. Start a sensitive call with meta["nexra/idempotencyKey"] (and optionally meta["nexra/correlationId"]).

MCP access token

An OAuth access token for the MCP endpoint. MCP clients get one through the sign-in metadata.

Parameters

Parameters
Field	Type	Description
name (path)required	string	The published tool to call, for example `search_capabilities`, `describe_capability` or `execute_capability`.

Request body · application/json

Request body
Field	Type	Description
argumentsrequired	object
meta	object	Request metadata: `nexra/idempotencyKey`, `nexra/correlationId`, `nexra/approvalRequestId`.

Examples

curl

curl -X POST "https://api.nexra.amakoragroup.com/api/gateway/tools/name_id" \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"arguments":{"connectionId":"<connection id>","operationKey":"customers.list","input":{"limit":2}}}'

Response · 201

Success.

Response fields
Field	Type	Description
contentrequired	array of object
isError	boolean

Errors: 400, 401, 429, 500. Error shape

GET/api/gateway/sdk/typescript

Download the Gateway SDK

The TypeScript Gateway client for Node.js 22+: files with nexra-gateway.cjs and nexra-gateway.d.cts. Save both in the same folder.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/api/gateway/sdk/typescript"),
);

Response · 200

Success.

Response fields
Field	Type	Description
versionrequired	string
runtimerequired	string
modulerequired	string
filesrequired	array of object

Errors: 404, 429, 500. Error shape

POST/mcp/pro

Send a message to the personal MCP server

Nexra for Professionals over MCP (Streamable HTTP, one JSON-RPC message per request, no session). Read-only desk_* research tools plus search and fetch. Its own OAuth resource and audience: tokens for /mcp are refused here and the other way round. Scopes: desk:research, and desk:work.read for the person's own tools (asked for on first use with a 403 insufficient_scope challenge).

MCP access token

An OAuth access token for the MCP endpoint. MCP clients get one through the sign-in metadata.

Request body · application/json

Request body
Field	Type	Description
jsonrpcrequired	"2.0"
id	string \| number
methodrequired	string
params	object

Examples

curl

curl -X POST "https://api.nexra.amakoragroup.com/mcp/pro" \
  -H "Authorization: Bearer $MCP_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"string"}'

Response · 200

Success.

Response fields
Field	Type	Description
jsonrpcrequired	"2.0"
idrequired	string \| number \| null \| null
result	object
error	object

Errors: 400, 401, 429, 500. Error shape

DELETE/mcp/pro

End a personal MCP session

The personal server keeps no session, so there is nothing to end; answers 204.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.DELETE("/mcp/pro"),
);

Response · 204

Success.

Errors: 404, 429, 500. Error shape

GET/.well-known/oauth-protected-resource/mcp/pro

Get personal MCP sign-in metadata

OAuth protected-resource metadata (RFC 9728) for /mcp/pro: its own resource, Nexra's authorisation server and the two scopes.

No sign-in needed

Anyone can call this operation.

Examples

javascript

import { createNexraClient, unwrap } from "@amakora/nexra-sdk";

const nexra = createNexraClient();
const result = unwrap(
  await nexra.GET("/.well-known/oauth-protected-resource/mcp/pro"),
);

Response · 200

Success.

Response fields
Field	Type	Description
resourcerequired	string
authorization_serversrequired	array of string
scopes_supportedrequired	array of string
bearer_methods_supportedrequired	array of string
resource_namerequired	string

Errors: 404, 429, 500. Error shape

Events sent to your endpoints

Nexra posts these to the endpoints you add under Event webhooks. Each request is signed: check X-Amakora-Signature with the SDK's constructEvent, answer with any 2xx within 8 seconds, and de-duplicate on the event id.

flow.run.succeeded

A flow run finished successfully

Every record in the run went through. Group: Flow runs.

flow.run.succeeded data
Field	Type	Description
runrequired	object
flowrequired	object
integrationrequired	object
countsrequired	object
reasonrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "flow.run.succeeded",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "run": {
      "id": "cmexec01run",
      "status": "succeeded",
      "trigger": "schedule",
      "startedAt": "2026-10-01T09:30:00.000Z",
      "completedAt": "2026-10-01T09:31:12.000Z",
      "durationMs": 72000
    },
    "flow": {
      "id": "cmflow01orders",
      "name": "Shopify orders to Xero invoices"
    },
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "counts": {
      "received": 42,
      "succeeded": 42,
      "failed": 0,
      "skipped": 0
    },
    "reason": null,
    "links": {
      "run": "https://console.example/dashboard/connect/runs/cmexec01run"
    }
  }
}

flow.run.failed

A flow run failed

The run stopped without sending its records. The reason says why. Group: Flow runs.

flow.run.failed data
Field	Type	Description
runrequired	object
flowrequired	object
integrationrequired	object
countsrequired	object
reasonrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "flow.run.failed",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "run": {
      "id": "cmexec01run",
      "status": "failed",
      "trigger": "schedule",
      "startedAt": "2026-10-01T09:30:00.000Z",
      "completedAt": "2026-10-01T09:31:12.000Z",
      "durationMs": 72000
    },
    "flow": {
      "id": "cmflow01orders",
      "name": "Shopify orders to Xero invoices"
    },
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "counts": {
      "received": 42,
      "succeeded": 0,
      "failed": 42,
      "skipped": 0
    },
    "reason": {
      "code": "run_deadline_exceeded",
      "message": "The run reached its 60-minute time limit, so Nexra stopped it before sending more."
    },
    "links": {
      "run": "https://console.example/dashboard/connect/runs/cmexec01run"
    }
  }
}

flow.run.partially_succeeded

A flow run finished with some records needing attention

Most records went through; the rest are waiting for review. Group: Flow runs.

flow.run.partially_succeeded data
Field	Type	Description
runrequired	object
flowrequired	object
integrationrequired	object
countsrequired	object
reasonrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "flow.run.partially_succeeded",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "run": {
      "id": "cmexec01run",
      "status": "partially_succeeded",
      "trigger": "schedule",
      "startedAt": "2026-10-01T09:30:00.000Z",
      "completedAt": "2026-10-01T09:31:12.000Z",
      "durationMs": 72000
    },
    "flow": {
      "id": "cmflow01orders",
      "name": "Shopify orders to Xero invoices"
    },
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "counts": {
      "received": 42,
      "succeeded": 39,
      "failed": 3,
      "skipped": 0
    },
    "reason": null,
    "links": {
      "run": "https://console.example/dashboard/connect/runs/cmexec01run"
    }
  }
}

record.dead_lettered

A record needs attention

A record stopped at a step and is waiting in the review list. Group: Flow runs.

record.dead_lettered data
Field	Type	Description
deadLetterrequired	object
recordrequired	object
runrequired	object
flowrequired	object
steprequired	object \| null
errorrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "record.dead_lettered",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "deadLetter": {
      "id": "cmdl01",
      "status": "open"
    },
    "record": {
      "id": "cmrec01"
    },
    "run": {
      "id": "cmexec01run"
    },
    "flow": {
      "id": "cmflow01orders",
      "name": "Shopify orders to Xero invoices"
    },
    "step": {
      "id": "cmstep01",
      "name": "Create invoice"
    },
    "error": {
      "code": "validation_failed",
      "category": "validation",
      "retryable": false
    },
    "links": {
      "deadLetters": "https://console.example/dashboard/connect/dead-letter",
      "run": "https://console.example/dashboard/connect/runs/cmexec01run"
    }
  }
}

approval.requested

An approval was requested

A change is waiting for someone with the right role to approve it. Group: Approvals.

approval.requested data
Field	Type	Description
approvalrequired	object
requestedByrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "approval.requested",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "approval": {
      "id": "approval_01",
      "action": "xero.invoices.create",
      "resourceType": "connector_action",
      "environment": "production",
      "requiredApprovals": 1,
      "status": "pending",
      "expiresAt": "2026-10-01T10:00:00.000Z"
    },
    "requestedBy": {
      "id": "cmuser01"
    },
    "links": {
      "approval": "https://console.example/dashboard/approvals"
    }
  }
}

approval.decided

An approval was decided

Someone approved or rejected a waiting change. Group: Approvals.

approval.decided data
Field	Type	Description
approvalrequired	object
decidedByrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "approval.decided",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "approval": {
      "id": "approval_01",
      "action": "xero.invoices.create",
      "resourceType": "connector_action",
      "environment": "production",
      "requiredApprovals": 1,
      "status": "approved",
      "decidedAt": "2026-10-01T09:31:12.000Z"
    },
    "decidedBy": {
      "id": "cmuser02"
    },
    "links": {
      "approval": "https://console.example/dashboard/approvals"
    }
  }
}

connection.health_changed

A connection's health changed

A connection became healthy, or stopped working (for example it needs reconnecting). Group: App connections.

connection.health_changed data
Field	Type	Description
connectionrequired	object
previousStatusrequired	string \| null
statusrequired	string
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "connection.health_changed",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "connection": {
      "id": "cmconn01",
      "name": "Xero (accounts)",
      "provider": "xero"
    },
    "previousStatus": "healthy",
    "status": "needs_reconnect",
    "links": {
      "connection": "https://console.example/dashboard/connect/connections"
    }
  }
}

connection.live_check.failed

A live connection check failed

Nexra checked a connection against your real app and something did not work. Group: App connections.

connection.live_check.failed data
Field	Type	Description
connectionrequired	object
checkrequired	object
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "connection.live_check.failed",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "connection": {
      "id": "cmconn01",
      "name": "Xero (accounts)",
      "provider": "xero"
    },
    "check": {
      "id": "cmcheck01",
      "status": "failed",
      "failedChecks": 1,
      "totalChecks": 1,
      "reason": {
        "code": "permission",
        "message": "The app did not allow Nexra to read invoices."
      }
    },
    "links": {
      "connection": "https://console.example/dashboard/connect/connections"
    }
  }
}

integration.paused

An integration was paused

No new runs start until someone resumes it. Group: Integrations.

integration.paused data
Field	Type	Description
integrationrequired	object
actorrequired	object \| null
runsStoppedrequired	integer
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "integration.paused",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "actor": {
      "id": "cmuser01"
    },
    "runsStopped": 2,
    "links": {
      "integration": "https://console.example/dashboard/connect/integrations/cmint01shop"
    }
  }
}

integration.resumed

An integration was resumed

Its flows run again on their schedules and triggers. Group: Integrations.

integration.resumed data
Field	Type	Description
integrationrequired	object
actorrequired	object \| null
runsStoppedrequired	integer
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "integration.resumed",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "actor": {
      "id": "cmuser01"
    },
    "runsStopped": 0,
    "links": {
      "integration": "https://console.example/dashboard/connect/integrations/cmint01shop"
    }
  }
}

integration.suspended

An integration was suspended

Nothing runs until a workspace owner or admin lifts the suspension. Group: Integrations.

integration.suspended data
Field	Type	Description
integrationrequired	object
actorrequired	object \| null
runsStoppedrequired	integer
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "integration.suspended",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "actor": {
      "id": "cmuser01"
    },
    "runsStopped": 1,
    "links": {
      "integration": "https://console.example/dashboard/connect/integrations/cmint01shop"
    }
  }
}

integration.deleted

An integration was deleted

It stops running and can be restored for 30 days. Group: Integrations.

integration.deleted data
Field	Type	Description
integrationrequired	object
actorrequired	object \| null
runsStoppedrequired	integer
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "integration.deleted",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "actor": {
      "id": "cmuser01"
    },
    "runsStopped": 0,
    "links": {
      "integration": "https://console.example/dashboard/connect/recently-deleted"
    }
  }
}

reconciliation.run.completed

A reconciliation finished

Nexra compared the two sides and counted what matched and what needs review. Group: Reconciliation.

reconciliation.run.completed data
Field	Type	Description
reconciliationrequired	object
runrequired	object
countsrequired	object
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "reconciliation.run.completed",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "reconciliation": {
      "id": "cmrecon01",
      "name": "Stripe payouts against Xero"
    },
    "run": {
      "id": "cmreconrun01",
      "status": "completed",
      "trigger": "schedule",
      "startedAt": "2026-10-01T09:30:00.000Z",
      "completedAt": "2026-10-01T09:31:12.000Z"
    },
    "counts": {
      "sourceRecords": 120,
      "targetRecords": 118,
      "matched": 116,
      "needsReview": 4
    },
    "links": {
      "run": "https://console.example/dashboard/connect/reconciliation/runs/cmreconrun01"
    }
  }
}

reconciliation.item.needs_review

A reconciliation item needs review

Something did not match and is waiting in the review list. Group: Reconciliation.

reconciliation.item.needs_review data
Field	Type	Description
reconciliationrequired	object
itemrequired	object
runrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "reconciliation.item.needs_review",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "reconciliation": {
      "id": "cmrecon01",
      "name": "Stripe payouts against Xero"
    },
    "item": {
      "id": "cmitem01",
      "kind": "unmatched_source",
      "status": "open"
    },
    "run": {
      "id": "cmreconrun01"
    },
    "links": {
      "review": "https://console.example/dashboard/connect/reconciliation/review/cmitem01"
    }
  }
}

go_live.completed

A flow went live

The flow now runs against your real (live) apps. Group: Going live.

go_live.completed data
Field	Type	Description
flowrequired	object
integrationrequired	object
revisionrequired	object
approvedByrequired	object \| null
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "go_live.completed",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "live",
  "workspaceId": "cmworkspace01",
  "data": {
    "flow": {
      "id": "cmflow01orders",
      "name": "Shopify orders to Xero invoices"
    },
    "integration": {
      "id": "cmint01shop",
      "name": "Online shop to accounts"
    },
    "revision": {
      "id": "cmrev01",
      "version": 3
    },
    "approvedBy": {
      "id": "cmuser02"
    },
    "links": {
      "flow": "https://console.example/dashboard/connect/flows/cmflow01orders"
    }
  }
}

obligation.due_soon

An obligation is due soon

Sent once for each due date when an open obligation comes within its reminder time (14 days unless you change it). Group: Obligations.

obligation.due_soon data
Field	Type	Description
obligationrequired	object
reminderrequired	object
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "obligation.due_soon",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "obligation": {
      "id": "obl_01",
      "reference": "Gas supply agreement GSA-2024-07",
      "counterparty": "Northfield Power",
      "sourceClause": "7.2",
      "dueDate": "2026-10-31",
      "recurrence": "monthly",
      "reminderLeadDays": 14
    },
    "reminder": {
      "kind": "due_soon",
      "summary": "Send the monthly volume statement (Gas supply agreement GSA-2024-07, Northfield Power) is due in 14 days, on 31 October 2026."
    },
    "links": {
      "obligation": "https://console.example/dashboard/connect/obligations/obl_01"
    }
  }
}

obligation.overdue

An obligation is overdue

Sent once for each due date when an open obligation passes it without being marked done. Group: Obligations.

obligation.overdue data
Field	Type	Description
obligationrequired	object
reminderrequired	object
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "obligation.overdue",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "obligation": {
      "id": "obl_01",
      "reference": "Gas supply agreement GSA-2024-07",
      "counterparty": "Northfield Power",
      "sourceClause": "7.2",
      "dueDate": "2026-10-31",
      "recurrence": "monthly",
      "reminderLeadDays": 14
    },
    "reminder": {
      "kind": "overdue",
      "summary": "Send the monthly volume statement (Gas supply agreement GSA-2024-07, Northfield Power) was due on 31 October 2026, 2 days ago."
    },
    "links": {
      "obligation": "https://console.example/dashboard/connect/obligations/obl_01"
    }
  }
}

workspace.daily_digest

The daily workspace digest

Sent once a day at 07:00 UTC: runs, connections needing attention, waiting approvals and review items, usage and changes from the last 24 hours. Group: Workspace.

workspace.daily_digest data
Field	Type	Description
digestrequired	object
countsrequired	object
sectionsrequired	array of object
linksrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "workspace.daily_digest",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "digest": {
      "id": "digest_01",
      "date": "2026-10-01",
      "windowStart": "2026-09-30T07:00:00.000Z",
      "windowEnd": "2026-10-01T07:00:00.000Z",
      "quiet": false,
      "headline": "2 things need your attention."
    },
    "counts": {
      "runsCompleted": 42,
      "runsFailed": 2,
      "runsPartlyCompleted": 0,
      "connectionsNeedingAttention": 1,
      "approvalsWaiting": 0,
      "reconciliationItemsToReview": 0,
      "recordsNeedingAttention": 0,
      "flowsPausedOrSuspended": 0,
      "flowsPublished": 1,
      "connectionsAdded": 0,
      "obligationsDueSoon": 0,
      "obligationsOverdue": 0,
      "pensionExceptions": 0,
      "pensionCasesInReview": 0,
      "issuesClearedAutomatically": 2
    },
    "sections": [
      {
        "key": "runs",
        "title": "Runs",
        "summary": "42 runs completed and 2 failed.",
        "items": [
          {
            "text": "Shopify orders to Xero invoices failed twice. The app did not answer in time.",
            "link": "https://console.example/dashboard/connect/runs/cmexec01run"
          }
        ]
      },
      {
        "key": "connections",
        "title": "Connections",
        "summary": "1 connection needs attention.",
        "items": [
          {
            "text": "Xero (accounts) needs reconnecting.",
            "link": "https://console.example/dashboard/connect/connections"
          }
        ]
      },
      {
        "key": "changes",
        "title": "Changes",
        "summary": "1 flow was published.",
        "items": [
          {
            "text": "Shopify orders to Xero invoices was published.",
            "link": "https://console.example/dashboard/connect/flows/cmflow01orders"
          }
        ]
      }
    ],
    "links": {
      "digest": "https://console.example/dashboard/"
    }
  }
}

sandbox.test

Test event

Sent when you press Send a test event. Sent when you choose Send a test event; it is always delivered and cannot be chosen.

sandbox.test data
Field	Type	Description
messagerequired	string
endpointrequired	object

Example

{
  "id": "evt_3f9a1c2b7d4e5f60718293a4",
  "type": "sandbox.test",
  "version": "2026-10-01",
  "createdAt": "2026-10-01T09:31:12.000Z",
  "mode": "test",
  "workspaceId": "cmworkspace01",
  "data": {
    "message": "This is a test event from Nexra. Your endpoint received it.",
    "endpoint": {
      "id": "wh_01",
      "name": "Order system"
    }
  }
}