Skip to main content

How to keep Sally tasks in sync with your system

Sally derives tasks from your conversations. This guide shows how to move them into the system your team actually uses and how to write back when a task is done.

Before you start

Read the Quickstart first.

Quick navigation

  1. Read tasks
  2. Create and change tasks
  3. Done is not canceled

1. Read tasks​

The list endpoint takes a filter preset that combines scope and state: my… covers your own tasks, all… every task of the company account you may see. The state part is Tasks (any), Open, Overdue, Completed or Forwarded, for example myOpen or allOverdue. The all… presets are reserved for admins and owners.

GET /v1.0/directories/{directoryId}/tasks?filter=myOpen

The search endpoint matches subject and description and filters by status (open, completed, overdue, canceled) and responsible person:

POST /v1.0/directories/{directoryId}/tasks/search

{ "search": "offer", "status": "overdue" }

A task knows where it came from: recordingSummaryId and appointmentId point back to the meeting. That lets you show the meeting context next to the task in your own tool.

2. Create and change tasks​

  • Create a task with a subject and optionally a description, a responsibleUserId and a dueDate.
  • Change a task with PATCH. Only the fields you send are changed.
  • Complete or reopen a task with its own call and { "isDone": true } or { "isDone": false }, so a completion is always unambiguous.
POST /v1.0/directories/{directoryId}/tasks/{taskId}/done

{ "isDone": true }

3. Done is not canceled​

This means

isDone with doneOn means finished, isCanceled with canceledOn means dropped. A task that is neither is still open. If you map both onto a single "closed" state in your system, you lose that difference.