Developers . Integrations

Automation API for Zapier, Make and custom apps

The HTTP API behind the Vindaris apps for Zapier and Make. Use it to push work from other tools into Vindaris.

In short

Sign in with OAuth 2.0, then call JSON endpoints under https://app.vindaris.com/api/connectors/{connector} to create tasks, goals, projects and KPIs, update the ones your connection created, record KPI values, post comments and look up goals and projects.

Overview

The automation API takes data in. It creates objects in a Vindaris workspace and keeps them up to date from another tool. Each connection owns the objects it creates, and it can update or comment only on those. You match an object by your own externalId, so you never have to store Vindaris ids.

The {connector} path segment names the integration: zapier or make. Each connector keeps its own set of external ids, so the same id used from Zapier and from Make refers to two different objects.

Every call runs with the signed-in person's access. A workspace admin must turn on AI Tools under Admin, and can switch Zapier or Make off under Allowed Integrations. The person's permission groups decide what they may read and change.

Authentication

The API uses OAuth 2.0 authorization code flow.

Send the token on every request:

Authorization: Bearer <access_token>

To register an OAuth client for your own app, contact support@vindaris.com.

Requests and responses

Requests and responses are JSON. A successful call returns HTTP 200 with:

{ "success": true, "data": { ... } }

A failed call returns an error status with a readable message:

{ "success": false, "error": "No task with external id \"crm-42\" that this connection created. Run the create step first, and pass the same external id." }
StatusMeaning
400A required field is missing or a value is invalid.
401The token is missing, revoked or invalid.
403AI Tools is off, the connector is switched off, or the person's permissions do not allow the action.
404No object with that external id was created by this connection.
409The external id is already used, or it belongs to a different object type.
429Too many requests. Wait and retry.

Endpoints

GET /me

Checks the connection. Returns the workspace and the signed-in person.

{ "success": true, "data": { "orgId": "...", "org": "acme", "user": "pat@acme.com", "connector": "MAKE", "connectionLabel": "acme (pat@acme.com)" } }

POST /tasks

Creates a task. The task shows the connector as its source.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
titlestringYes
descriptionstringNo
statusenumNoTODO, IN_PROGRESS, BLOCKED, IN_REVIEW, DONE or ARCHIVED.
priorityenumNoLOW, MEDIUM, HIGH or URGENT.
dueDatedate (YYYY-MM-DD or ISO 8601)No
startDatedateNo
alignToTypeenumNoGOAL or PROJECT.
alignToIdstringNoVindaris id of the goal or project, from the search endpoints.
externalUrlstringNoLink back to the object in the source app.
externalToolstringNoName of the source app, shown in Vindaris.
{ "success": true, "data": { "id": "cmw...", "externalId": "crm-42" } }

POST /tasks/update

Updates a task this connection created. Status changes count as a work signal, like a Jira or Asana sync.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
statusenumNoTODO, IN_PROGRESS, BLOCKED, IN_REVIEW, DONE or ARCHIVED.
titlestringNo
descriptionstringNo
priorityenumNo
dueDatedate (YYYY-MM-DD or ISO 8601)No
startDatedateNo

POST /goals

Creates a goal.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
titlestringYes
dueDatedateYes
descriptionstringNo
statusenumNoDRAFT, ACTIVE, COMPLETED or CANCELLED.
typeenumNoOKR, SMART, OGSM or CUSTOM.
startDatedateNo
externalUrlstringNoLink back to the object in the source app.
externalToolstringNoName of the source app, shown in Vindaris.

POST /goals/update

Updates a goal this connection created.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
titlestringNo
descriptionstringNo
statusenumNoDRAFT, ACTIVE, COMPLETED or CANCELLED.
startDatedateNo
dueDatedate (YYYY-MM-DD or ISO 8601)No

POST /projects

Creates a project.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
titlestringYes
descriptionstringNo
statusenumNoDRAFT, ACTIVE, COMPLETED or CANCELLED.
startDatedateNo
endDatedateNo
externalUrlstringNoLink back to the object in the source app.
externalToolstringNoName of the source app, shown in Vindaris.

POST /projects/update

Updates a project this connection created.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
titlestringNo
descriptionstringNo
statusenumNoDRAFT, ACTIVE, COMPLETED or CANCELLED.
startDatedateNo
endDatedateNo

POST /kpis

Creates a KPI.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
titlestringYes
unitstringNoFor example %, EUR or users.
startValuenumberNo
targetValuenumberNo
currentValuenumberNo
startDatedateNo
dueDatedate (YYYY-MM-DD or ISO 8601)No
externalUrlstringNoLink back to the object in the source app.
externalToolstringNoName of the source app, shown in Vindaris.

POST /kpis/update

Updates a KPI this connection created. A currentValue is recorded as today's measurement.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
currentValuenumberNo
targetValuenumberNo
titlestringNo
statusenumNoDRAFT, ACTIVE, COMPLETED or CANCELLED.
startDatedateNo
dueDatedate (YYYY-MM-DD or ISO 8601)No

POST /comments

Posts a comment on a task, goal, project or KPI this connection created.

FieldTypeRequiredNotes
externalIdstringYesThe id of the object in your source app. Use the same value on create and on every later update or comment.
bodystringYesThe comment text.
{ "success": true, "data": { "id": "...", "entityType": "TASK", "entityId": "cmw..." } }

GET /search/goals

Finds active goals by name, for example to align a task. Returns up to 50 results the person may read.

FieldTypeRequiredNotes
qstring (query)NoPart of the goal name.
{ "success": true, "data": [ { "id": "cmw...", "name": "Grow EU revenue" } ] }

GET /search/projects

Finds active projects by name. Returns up to 50 results the person may read.

FieldTypeRequiredNotes
qstring (query)NoPart of the project name.

Example

curl -X POST https://app.vindaris.com/api/connectors/make/tasks \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"crm-42","title":"Call back Acme","status":"TODO"}'

curl -X POST https://app.vindaris.com/api/connectors/make/tasks/update \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"crm-42","status":"DONE"}'
Try Vindaris free

Put this into practice

Vindaris keeps strategy, goals, projects and tasks in one place, and the Work Graph flags execution risk before it costs you. Start free, no credit card.

Sign Up for Free