Your company workspace →
DEVELOPER DOCS

Connect your company to Prepare SI

Give your people a daily planner and prep coach that already knows their work. Your tasks and events flow into each person’s hour-by-hour plan, ticks flow back to you, and Prepare SI opens inside your app, signed in, with your brand.

Start here: sign in, open Connected companies, and create a company workspace. You get an API key (psk_…) and a signing secret (pss_…). Keep both on your server only.

1. Open Prepare SI for a person

From your server, ask for a signed-in link for one of your users. Use your own stable user id as external_id. The first call creates their Prepare SI workspace.

POST https://prepare.visionfarm.tech/api/v1/sessions
Authorization: Bearer psk_…
Content-Type: application/json

{ "external_id": "user-42", "name": "Jasmine", "tz": "America/New_York" }

→ { "url": "https://prepare.visionfarm.tech/app#t=…", "expires_in": 43200 }

Load the url in an iframe or a new tab. It’s good for 12 hours; request a fresh one each time the person opens it. The link signs them into their company workspace only, never into a personal account with the same email.

<iframe src="{url}" style="width:100%;height:100vh;border:0" allow="clipboard-write"></iframe>

2. Send tasks and events

Option A: a live task feed (recommended)

Set a Task feed URL in your workspace. Whenever Prepare SI builds or opens a person’s day, it calls:

GET {your feed URL}?external_id=user-42&day=2026-10-20
X-Prepare-Timestamp: 1760900000
X-Prepare-Signature: hex HMAC-SHA256(secret, "{timestamp}.{external_id}.{day}")

Respond within 6 seconds:

{
  "tasks":  [ { "key": "post-ig", "title": "Post on Instagram", "mins": 10, "when": "morning", "link": "https://yourapp.com/compose" } ],
  "events": [ { "key": "bk-881", "title": "Photo shoot", "start": "14:00", "end": "16:00", "location": "Studio B", "travel_mins": 25 } ]
}

Option B: push

PUT https://prepare.visionfarm.tech/api/v1/items
Authorization: Bearer psk_…

{ "external_id": "user-42", "day": "2026-10-20", "items": [ { "key": "post-ig", "title": "Post on Instagram", "mins": 10 } ] }

Each push replaces what you sent before for that person and day.

FIELDMEANING
keyYour stable id for the item (required). Used for completions.
titleWhat they see (required).
minsTasks: how long it takes (default 30).
whenTasks: morning, midday, afternoon or evening hint.
start, endEvents: HH:MM in the person’s local time. Events are fixed; the plan works around them.
location, travel_minsAdds a travel block and a leave-by time.
linkhttps link back into your app (“Open in …”).
done, noteAlready done; a short note.

3. Get completions back

Set a Completion URL. When the person ticks one of your tasks (or unticks it):

POST {your completion URL}
X-Prepare-Timestamp: 1760900000
X-Prepare-Signature: hex HMAC-SHA256(secret, "{timestamp}.{raw body}")

{ "external_id": "user-42", "day": "2026-10-20", "key": "post-ig", "done": true }

Verify the signature and reject timestamps older than 5 minutes:

import { createHmac, timingSafeEqual } from 'node:crypto';
function verify(secret, ts, payload, sig) {
  if (Math.abs(Date.now() / 1000 - Number(ts)) > 300) return false;
  const want = createHmac('sha256', secret).update(`${ts}.${payload}`).digest('hex');
  return want.length === sig.length && timingSafeEqual(Buffer.from(want), Buffer.from(sig));
}

You can also read status any time: GET /api/v1/plan?external_id=user-42&day=2026-10-20 returns your items, when they’re scheduled, and whether they’re done. The full day plan is included only if the person turned on sharing.

4. Prep templates

PUT https://prepare.visionfarm.tech/api/v1/templates
Authorization: Bearer psk_…

{ "templates": [ { "key": "shoot-day", "name": "Shoot day", "type": "Shoot",
  "tasks": ["Confirm shot list and outfits", "Charge batteries", "Pack props and lighting"], "notes": "Studio B, side entrance" } ] }

Types: Meeting, Presentation, Date, Interview, Shoot, Hard conversation, Travel, Appointment, Event, Other. Templates appear in each connected person’s playbook.

Privacy

Plans are private by default. Your company sees its own items and whether they’re done. A person’s full day plan is visible to you (in the API and the Team view) only when they switch on “Share my day plan with …”, and they can switch it off any time.

Check your key: GET /api/v1/org.