Requirements
Prepare the provider account, permissions, and camera access before opening the integration in GuardDog.
Credentials
API key
RequiredA Surfsight API key with access to the organization, devices, events, media, webhooks, and live streaming.
Organization IDs
OptionalRequired when a partner API key can see multiple organizations. Enter the exact comma-separated Surfsight organization IDs for this GuardDog tenant.
Provider account checklist
- A Surfsight API key that can access the intended organization and devices.
- Organization, device, event, event-media, webhook-management, and connect-media permissions.
- The exact Surfsight organization IDs when a partner key can access more than one customer.
- At least one active Surfsight camera with event upload and live video allowed by its privacy/media settings.
Capabilities
Device discovery
Supported
Sync devices across the bound Surfsight organizations and match them by IMEI.
Safety events
Supported
Receive tenant-bound event and media-availability webhook deliveries.
Incident video
Supported
Resolve uploaded road-, cabin-, and auxiliary-camera event files.
Live video
Supported
Prepare authenticated WebRTC live media sessions through connect-media.
Setup guide
- 1
Create or obtain the API key
Use the Surfsight developer portal to obtain a key with access to organizations, devices, events, media, webhooks, and streaming.
- 2
Identify organization IDs
If the key is partner-scoped, list only the Surfsight organization IDs belonging to this GuardDog customer.
- 3
Connect Surfsight in GuardDog
Open Integrations, choose Lytx Surfsight, enter the key and any required organization IDs, then test the connection.
- 4
Save and provision webhooks
GuardDog binds the selected organizations and creates or reconciles device subscriptions for events and media availability.
- 5
Discover and assign cameras
Run device discovery and assign each device IMEI to the corresponding GuardDog unit.
- 6
Verify event and live media
Use a controlled event or recent demo event to confirm event files, then start and stop a live session from the unit page.
Provider configuration
- GuardDog’s Lytx connector targets the Surfsight API. Confirm the fleet is on Surfsight before starting setup.
- A partner key that can see multiple organizations must be narrowed to the exact customer organization IDs before saving.
- Organization bindings are locked after connection so a later credential rotation cannot silently cross tenant boundaries.
- Event video depends on the camera’s event-media upload settings. Live video also depends on device connectivity, privacy settings, and available data allowance.
Verify the integration
Complete each check before enabling the provider for production alerting.
- CheckThe API key resolves only the intended Surfsight organization IDs.
- CheckDevice discovery lists the expected IMEIs and camera metadata.
- CheckThe integration reports event/media webhook subscriptions for available devices.
- CheckA safety event attaches its available road/cabin media files.
- CheckA live video session starts, renders, and stops from the assigned unit.
Before generating a test event: verify the GuardDog organization, branch, contacts, call settings, and provider demo account. A real event can start texts and paid calls when alerting is enabled.
Troubleshooting
The key can access multiple organizations+
Enter the exact customer organization IDs in GuardDog. Do not connect an unrestricted partner key without tenant scoping.
Webhook setup reports no devices+
Confirm the selected organizations contain active devices and that the key can list them.
An event arrives without video+
Confirm event media upload is enabled and wait for the media-availability notification when the camera uploads asynchronously.
Live video does not start+
Confirm the camera is online, privacy settings allow live streaming, and the API key can call connect-media.