Help Centre / API / Webhooks

Webhooks

Updated just now · 6 views ·

Webhooks let MapVS push events to your systems in near real-time - a recording was uploaded, a run was completed, an improvement moved to Done.

Configure endpoints

Account Settings > Integrations > Webhooks. Enter your endpoint URL, select which events to subscribe to, and save. You'll get a signing secret to verify payloads on your side.

Payload structure

{
  "event": "recording.uploaded",
  "id": "evt_abc123",
  "created": 1737532800,
  "data": {
    "recording_id": 4123,
    "map_id": 88,
    "step_count": 12
  }
}

Signing

Every request includes an X-MapVS-Signature header. Compute HMAC-SHA256 of the raw request body using your signing secret and compare. Reject requests with mismatched signatures.

Retries

MapVS retries failed deliveries (non-2xx or timeout) with exponential backoff: 1min, 5min, 30min, 1hr, 6hr. Gives up after 24hrs. Design your endpoint to be idempotent - use the id field to dedupe.

Was this article helpful?

0 found this helpful