API access and webhooks.

The workspace and its members.

{
  "id": "01J8ZQ3K4X0000000000000000",
  "name": "Lantern Pictures",
  "created_at": "2026-01-14T09:12:00Z",
  "members": [
    { "id": "01J8…", "name": "Ada Wren", "email": "ada@lantern.example", "role": "owner" }
  ]
}

Every production in the workspace.

{
  "projects": [
    { "id": "01J8…", "title": "Night Bus", "description": null, "created_at": "2026-02-03T18:40:11Z" }
  ]
}

One production and its scripts. The list includes archived scripts. The archived_at field identifies them.

{
  "id": "01J8…",
  "title": "Night Bus",
  "description": null,
  "created_at": "2026-02-03T18:40:11Z",
  "scripts": [ { …script row… } ]
}

The scripts in one production, including archived scripts.

{ "scripts": [ { …script row… } ] }

One script record with an ETag header.

{
  "id": "01J8…",
  "title": "Night Bus",
  "project_id": "01J8…",
  "kind": "screenplay",
  "template": false,
  "page_format": "letter",
  "revision": "white",
  "encrypted": false,
  "archived_at": null,
  "content_version": 1757930118,
  "created_at": "2026-02-03T18:41:02Z",
  "updated_at": "2026-09-15T10:35:18Z",
  "metadata": {
    "logline": "A bus, at night.",
    "format": "Feature",
    "revision": "white",
    "title_page": { "title": "NIGHT BUS", "author": "Ada Wren" },
    "season_number": null,
    "episode_number": null
  }
}

The script as an exported file. Use ?format=fountain, fdx, pdf, or docx. The default format is fountain. PDF options are revised=1, marks=1, comments=1, title=0, and stamp=Name.

INT. BUS - NIGHT

The bus idles.

Saved versions, with the newest first. The automatic field is true for hourly captures.

{
  "versions": [
    { "id": "01J9…", "label": "Draft one", "automatic": false, "wordCount": 18240, "createdAt": "2026-09-12T16:02:44Z" }
  ]
}

Each shoot day and its assigned scene ordinals. The response also includes the production calendar: preparation, shooting, post-production, milestones, and off periods.

{
  "days": [
    {
      "id": "01JA…",
      "title": "Day 1",
      "date": "2026-03-02",
      "unit": "2nd unit",
      "location": "Bus depot",
      "location_key": "01JB…",
      "first_call_at": "2026-03-02T07:00:00Z",
      "scene_ordinals": [12, 13, 4],
      "parking": null, "hospital": null, "weather": null, "safety": null, "notes": null,
      "created_at": "2026-02-10T09:00:00Z",
      "updated_at": "2026-02-28T17:04:00Z"
    }
  ],
  "events": [
    { "id": "01JC…", "kind": "prep", "title": "Prep week", "starts_on": "2026-02-23",
      "ends_on": "2026-02-27", "start_time": null, "notes": null,
      "created_at": "2026-02-01T11:00:00Z", "updated_at": "2026-02-01T11:00:00Z" }
  ]
}

The current call sheet for one day. It includes scenes in shooting order, cast, breakdown tags, shots, crew, and call times. It does not include phone numbers.

{
  "day": {
    "id": "01JA…", "title": "Day 1", "date": "2026-03-02",
    "location": "Bus depot — 1 Depot Road",
    "location_coords": { "lat": 51.5072, "lng": -0.1276 },
    "unit": "2nd unit", "first_call_at": "2026-03-02T07:00:00Z",
    "parking": "Yard", "hospital": "St Thomas'", "weather": "Clear, high 9°C",
    "safety": null, "notes": null,
    "department_notes": [ { "department": "camera", "note": "Second body on the 35." } ],
    "scene_ordinals": [12, 13]
  },
  "events": [ { "id": "01JD…", "label": "Lunch", "starts_at": "2026-03-02T13:00:00Z", "ends_at": "2026-03-02T13:30:00Z" } ],
  "scenes": [ { "number": "12", "uid": "01JE…", "heading": "INT. BUS - NIGHT", "omitted": false,
    "int_ext": "INT", "location": "BUS", "time_of_day": "NIGHT", "eighths": 6 } ],
  "cast": [ { "character": "WIM", "actor": "Iris Vale", "scene_ordinals": [12] } ],
  "breakdown": [ { "category": "prop", "label": "Torch", "scene_heading": "INT. BUS - NIGHT" } ],
  "shots": [ { "scene_ordinal": 12, "scene_heading": "INT. BUS - NIGHT", "shot_type": "WIDE",
    "description": "The bus idles", "movement": "static", "angle": "eye", "lens": "35mm",
    "duration_min": 2, "setup": "A", "done": false } ],
  "crew": [ { "id": "01JF…", "name": "Ada Wren", "department": "camera", "position": "DP",
    "call_at": "2026-03-02T06:30:00Z", "note": null } ]
}

The day out of days lists characters, work days, and daily codes. SW means start-work, W means work, and WF means work-finish. SWF identifies one-day work. H means hold. Characters with the most work days are first.

{
  "days": [ { "id": "01JA…", "title": "Day 1", "date": "2026-03-02" } ],
  "rows": [
    { "character": "WIM", "work_days": 2, "hold_days": 1, "total_days": 3,
      "days": [ { "day_id": "01JA…", "code": "SW" }, { "day_id": "01JB…", "code": "H" },
        { "day_id": "01JC…", "code": "WF" } ] }
  ],
  "unavailable": [ { "character": "WIM", "from": "2026-03-03", "to": "2026-03-03" } ]
}

The crew list in call-sheet order. The response does not include email addresses, phone numbers, or rates.

{
  "crew": [
    { "id": "01JF…", "name": "Ada Wren", "department": "camera", "position": "DP",
      "call_offset_min": -30, "created_at": "2026-02-10T09:00:00Z", "updated_at": "2026-02-10T09:00:00Z" }
  ]
}

The cast list includes each character, actor, agency, and agent name. It does not include contact details.

{
  "cast": [
    { "id": "01JG…", "character": "Wim", "character_key": "WIM", "actor_name": "Iris Vale",
      "agency": "Talent Co", "agent_name": "Nell Roe", "position": 1,
      "created_at": "2026-02-11T14:00:00Z", "updated_at": "2026-02-20T10:12:00Z" }
  ]
}

Every breakdown tag in the script, ordered by category and label. The key field contains the document tag ID. Each row carries the item's element profile: description, notes, status (needed, sourced, on_hand, wrapped, or null), quantity, source, cost_cents in the budget currency (the currency field of GET /scripts/:id/budget), and the owning crew member. These fields are null or empty when the item has no profile.

{
  "breakdown": [
    { "key": "prop:torch", "category": "prop", "label": "Torch", "character": null,
      "set_name": "Night 1", "scene_heading": "INT. BUS - NIGHT",
      "description": "Brass hand torch, working", "notes": "", "status": "sourced",
      "quantity": 2, "source": "Prop house", "cost_cents": 12500,
      "owner_key": "01JH…", "owner_name": "Ada Props",
      "created_at": "2026-02-12T08:30:00Z", "updated_at": "2026-02-12T08:30:00Z" }
  ]
}

The priced budget: settings, scenarios, accounts with their totals, every line in the view with its price, and the grand total. Money fields are integer hundredths of the currency. Use ?scenario= with a key from scenarios to price that scenario; the default is the base budget, and an unknown key returns 404. The lock is null until the budget is locked. A script with no budget returns the empty default budget.

{
  "currency": "USD", "days_per_week": 5, "fx": { "EUR": 1.08 },
  "lock": { "at": "2026-03-01T09:00:00Z", "by_name": "Ada Wren" },
  "scenarios": [ { "key": "01JK…", "name": "Six-day weeks" } ],
  "accounts": [
    { "key": "01JL…", "number": "2200", "name": "Set design", "group": "production",
      "totals": { "total_cents": 1250000, "actual_cents": 0, "committed_cents": 0,
        "etc_cents": 1250000, "efc_cents": 1250000, "variance_cents": 0, "locked_cents": 1250000 } }
  ],
  "lines": [
    { "key": "01JM…", "account": "01JL…", "description": "Production designer", "unit": "week",
      "qty": 5, "rate_cents": 250000, "pct_of": "total", "currency": null,
      "fringe_pct": 0, "fringe_key": null, "actual_cents": null, "committed_cents": null,
      "etc_cents": null, "locked_cents": 1250000, "link": null,
      "rate_link": { "type": "crew_day_rate", "crew_key": "01JF…", "crew_name": "Nell Roe" },
      "scenario": null, "note": "",
      "price": { "base_cents": 1250000, "fringe_cents": 0, "total_cents": 1250000, "reported": false,
        "actual_cents": null, "committed_cents": null, "etc_cents": 1250000, "efc_cents": 1250000,
        "variance_cents": 0, "locked_cents": 1250000 } }
  ],
  "grand": { "total_cents": 1250000, "actual_cents": 0, "committed_cents": 0,
    "etc_cents": 1250000, "efc_cents": 1250000, "variance_cents": 0, "locked_cents": 1250000 }
}

Production locations include addresses, coordinates, parking, the nearest hospital, tags, and the script sets at each location. The response does not include keyholder contact details.

{
  "locations": [
    { "id": "01JB…", "name": "Bus depot", "address": "1 Depot Road", "lat": 51.5072, "lng": -0.1276,
      "notes": null, "parking": "Yard", "hospital": "St Thomas'", "tags": ["night"], "sets": ["BUS"],
      "created_at": "2026-02-09T12:00:00Z", "updated_at": "2026-02-09T12:00:00Z" }
  ]
}

Production tasks include the assignee name. They do not include the assignee email address.

{
  "tasks": [
    { "id": "01JH…", "title": "Book the bus", "status": "open", "assignee_name": "Ada Wren",
      "due_on": "2026-03-01", "done_at": null, "scene_ordinal": 12, "shoot_day_key": "01JA…",
      "created_at": "2026-02-14T16:00:00Z", "updated_at": "2026-02-14T16:00:00Z" }
  ]
}

The shot list in shooting order, from SHOT elements in the script.

{
  "shots": [
    { "key": "01JI…", "scene_ordinal": 12, "scene_heading": "INT. BUS - NIGHT", "shot_type": "WIDE",
      "description": "The bus idles", "movement": "static", "angle": "eye", "lens": "35mm",
      "duration_min": 2, "setup": "A", "done": false, "position": 0,
      "created_at": "2026-02-15T10:00:00Z", "updated_at": "2026-02-15T10:00:00Z" }
  ]
}

Only approved time cards. The computed field contains the agreement calculations: hours, pay bands, night hours, meal penalty, day multiplier, and estimated pay in cents.

{
  "time_cards": [
    { "id": "01JJ…", "shoot_day_id": "01JA…", "crew_member_key": "01JF…", "name": "Ada Wren",
      "started_at": "2026-03-02T07:00:00Z", "meal_started_at": "2026-03-02T13:00:00Z",
      "meal_ended_at": "2026-03-02T13:30:00Z", "ended_at": "2026-03-02T20:00:00Z",
      "note": null, "status": "approved", "reviewed_at": "2026-03-03T09:00:00Z",
      "computed": { "hours": 12.5, "straight": 8.0, "overtime": 4.0, "double_time": 0.5,
        "night_hours": 0.0, "meal_penalty_cents": 0, "day_multiplier_pct": 100,
        "estimate_cents": 61250 },
      "created_at": "2026-03-02T20:05:00Z", "updated_at": "2026-03-03T09:00:00Z" }
  ]
}

The workspace audit log, with the newest first and 50 records per page. To get the next page, use nextBefore as ?before=. At the end, nextBefore is null. Use ?group=security to filter by an event group listed under Webhooks.

{
  "events": [
    {
      "id": "01J9…",
      "action": "organization.mfa_required",
      "actor": "Ada Wren",
      "details": {},
      "createdAt": "2026-09-14T08:00:12Z"
    }
  ],
  "nextBefore": "01J9…"
}

These event groups match the audit page filters:

• access.session.signed_in, script.opened, script.exported, membership.role_changed, membership.removed, membership.auto_joined, invite.sent, invite.revoked, invite.accepted
• sharing.share_link.created, share_link.download_changed, share_link.revoked, share_link.viewed, share_link.downloaded, file.sent, announcement.sent
• security.organization.mfa_required, organization.mfa_unrequired, organization.cloud_ai_forbidden, organization.cloud_ai_allowed, organization.link_passcode_required, organization.link_passcode_unrequired, organization.link_downloads_forbidden, organization.link_downloads_allowed, organization.link_max_age_set, organization.link_max_age_cleared, organization.encryption_required, organization.encryption_unrequired, organization.session_max_age_set, organization.session_max_age_cleared, script.encrypted, script.decrypted, sso.connected, sso.updated, sso.disconnected, sso.domain_verified, sso.enforced, sso.unenforced
• scripts.organization.renamed, organization.exported, script.created, script.renamed, script.archived, script.unarchived, file.uploaded, file.removed, budget.locked, budget.unlocked
• developers.api_token.created, api_token.revoked, webhook.created, webhook.updated, webhook.removed

Only Studio records sign-ins, script opens, exports, and guest views. Other events are available on every plan. Webhook delivery requires Studio.

Each delivery uses POST with a JSON body and these headers:

• X-Screencake-Event: the event name.
• X-Screencake-Delivery: the event ID, which stays the same on retries.
• X-Screencake-Signature: the signature and timestamp.

Use the event ID to prevent duplicate processing.

{
  "id": "01J9ABCD…",
  "type": "script.renamed",
  "created_at": "2026-09-15T10:35:18Z",
  "organization": { "id": "01J8…", "name": "Lantern Pictures" },
  "actor": { "id": "01J8…", "name": "Ada Wren" },
  "subject": { "type": "script", "id": "01J8…", "title": "Night Bus" },
  "details": { "script": "Night Bus", "from": "Untitled Script" }
}

For system or guest actions, actor is null. If an event has no single subject, subject is null. If the subject was deleted, its id is null. The event details remain available.

The signature header has the form t=<unix seconds>,v1=<hex>. The v1 value is an HMAC-SHA256 signature of <t>.<raw body>, calculated with your signing secret.

1. Calculate the signature from the received body bytes. Do not serialize the JSON again.
2. Compare signatures with a constant-time comparison.
3. Reject timestamps outside your permitted interval.

import { createHmac, timingSafeEqual } from 'node:crypto'

// rawBody: the request body as received — bytes, not re-serialised JSON.
export function verify(header, rawBody, secret, tolerance = 300) {
  const parts = Object.fromEntries(header.split(',').map((p) => p.split('=')))
  const expected = createHmac('sha256', secret)
    .update(`${parts.t}.${rawBody}`)
    .digest('hex')
  const fresh = Math.abs(Date.now() / 1000 - Number(parts.t)) <= tolerance
  return fresh && timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1))
}

require "openssl"

# raw_body: the request body as received — bytes, not re-serialised JSON.
def verify(header, raw_body, secret, tolerance: 300)
  parts = header.split(",").to_h { |pair| pair.split("=", 2) }
  expected = OpenSSL::HMAC.hexdigest("SHA256", secret, "#{parts["t"]}.#{raw_body}")
  fresh = (Time.now.to_i - parts["t"].to_i).abs <= tolerance
  fresh && OpenSSL.secure_compare(expected, parts["v1"])
end

Return a 2xx response within ten seconds.

For a timeout, 5xx, or 429, Screencake makes up to 5 delivery attempts in total. The delay increases between attempts. Other responses count as failures without retries.

After 10 deliveries fail one after the other, Screencake turns off the endpoint. The Developers page shows its last error and failure count. To turn on the endpoint and reset the count, turn on Active. Events that occur while the endpoint is off are not sent later.