Your own account

Building on your own account

For a RapidEye Premium customer building on their own workspace: issue recording links from your own system, read the results, and receive webhooks. Partners integrating many customers use the rest of this guide instead.

• One workspace per key. A workspace key acts for the workspace that made it, and nothing else. No request here takes a workspace_id.
• Our ids. property_id and inspection_id are RapidEye's on every call. task_id is yours.
• Shared rules. Base URL, JSON, pagination, the error envelope and the rate limit are as in Conventions and Authentication.

Getting a key

• Where: Settings › Workspace › API, by an owner or admin of the workspace. A workspace holds up to 5 active keys.
• Shown once. Copy the key when you create it. We cannot show it again.
• Send it on every request as Authorization: Bearer rapideye_wk_.... Keep it on your server, never in an app or a web page.
• Check it with GET /v1/me.

What a workspace key can call

• Every workspace key carries these three scopes.
• Every other route answers 403 not_available_to_workspace_keys. Set up homes and checklists in the RapidEye app.

Findings and video

GET /v1/inspections/{inspection_id}/findings and GET /v1/inspections/{inspection_id}/video answer a workspace key exactly as they answer a partner, without workspace_id. Both take our inspection_id and need read:inspections. An inspection in another workspace answers 404 not_found, the same as one that does not exist.

Webhooks for your account

• Register in Settings › Workspace › API: one HTTPS receiver per workspace, reachable from the internet, and the events you want. Any port; no query string or # fragment; a host name or IPv4 address, not an IPv6 address. The signing secret is shown once when you save.
• Every inspection in your workspace, whether or not it started from your link. A receiver you save also gets Walkthrough saved for walkthroughs saved in the 6 hours before.
• Send test event in Settings sends webhook.test, carrying only version, event_id, event_type, company_id and sent_at. It works while the webhook is paused.

The payloads are the ones in What we send back to you, with three differences:

• company_id in place of workspace_id. It is your workspace's id.
• property_id is ours.
• task_id is yours, or null for a walkthrough not started from your link.

{
  "version": 1,
  "event_id": "5d0b8f2e-6c1a-4f3e-9a77-1e2d3c4b5a69",
  "event_type": "inspection.recording_completed",
  "company_id": "b57d44f0-1c2e-4f3a-9d61-0c8f1b7e2a55",
  "task_id": "chore_2026w42_r17",
  "property_id": "8c1e4b7a-90d2-4f55-a3f1-1d2e9b0c6a44",
  "inspection_id": "3b7f1a90-2c44-4b6d-9e01-7a5c2f8e1d33",
  "recorded_at": "2026-10-20T18:02:11Z",
  "checklist": {
    "status": "complete",
    "counts": { "verified": 2, "missed": 1, "explained": 0, "not_checked": 0, "pending": 0 },
    "items": [
      { "id": "c1f0a2e4-...", "name": "Kitchen: counters wiped", "state": "verified",
        "timestamp": 41.7, "image_url": "https://...signed..." }
    ]
  }
}

• Verify every delivery as in Verifying our signature. Retries, timeouts and duplicates follow Delivery semantics.
• A receiver that keeps failing pauses. If deliveries keep failing for 3 days, we pause the webhook and email the workspace's owners once. Events while it is paused are not sent, and Resume in Settings does not resend them. For walkthroughs started from your links, GET /v1/inspections?task_id=... has the result of anything you missed.
• Off Premium, events are not sent, and are not sent later when the workspace is back on Premium.

Errors and limits

Besides each route's own codes, any route here can return:

Keys over time

• Replace a key by creating a new one, deploying it, then revoking the old one in Settings. Revoking is immediate and permanent: the old key answers 403 key_revoked.
• A leaked key: revoke it in Settings at once.
• Rotate the webhook secret with Rotate in Settings. The new secret is shown once, and the old one keeps signing alongside it for 7 days, so each signature header carries two entries and either secret verifies. Deploy the new one within those 7 days. Rotating again inside them ends the earlier secret's overlap at once, so Settings asks you to confirm.