← Back to Developer CenterExamples
Guided testing

Developer Workbench

Swagger tells you what the API contract is. The workbench tells you how to make a useful DataSynch workflow work from start to finish.

Import Locations

Load location master data and prepare it for geofence, telemetry, and map workflows.

DataSynch → Locations
Ideal for

Warehouses, DCs, customer sites, stores, docks, yards, service zones, and delivery points.

Required context
  • companyId when enforced
  • workspaceId when available
  • manifestId
Auth modes
  • App tenant auth
  • x-api-key through API Gateway
  1. 1
    Prepare location records

    Use stable external IDs and preserve raw source fields in metadata.

  2. 2
    Import into master table

    Send dynamic records into the locations target table.

    /api/datasynch/master-tables/importOpen example
  3. 3
    Create geofences for operational zones

    Create point-radius or polygon fences for important locations.

    /api/datasynch/geofencesOpen example

Import CRM Records

Load account, customer, prospect, partner, or territory records.

DataSynch → CRM
Ideal for

Account overlays, customer mapping, support handoffs, and territory views.

Required context
  • companyId when enforced
  • workspaceId when available
  • manifestId
Auth modes
  • App tenant auth
  • x-api-key through API Gateway
  1. 1
    Prepare CRM records

    Use externalId for upsert-style imports and preserve source fields.

  2. 2
    Import CRM records

    Send customer or account data into the CRM domain route.

    /api/datasynch/crm/importOpen example
  3. 3
    Use XREF for account/location matching

    Evaluate cross-reference rules before committing related operational records.

    /api/datasynch/xref/evaluateOpen example

Send Telemetry Event

Send shipment, carrier, equipment, EDI, mobile, scanner, or IoT events into DataSynch.

DataSynch → Telemetry
Ideal for

214/315-style logistics events, geofence checks, ETA updates, and status feeds.

Required context
  • manifestId
  • shipmentId or equipmentId
  • eventTime
  • eventCode or eventDescription
Auth modes
  • x-api-key through API Gateway
  • App tenant auth
  1. 1
    Create telemetry event

    Post the event with coordinates, references, and source metadata.

    /api/datasynch/telemetry/eventsOpen example
  2. 2
    Evaluate geofence behavior

    Use event coordinates to produce enter, exit, dwell, wrong-site, or proximity events.

    /api/datasynch/geofence-eventsOpen example
  3. 3
    Dispatch downstream action

    Send a notification or webhook if rules require action.

    /api/datasynch/notification-dispatchOpen example

Normalize → Map Fields → XREF → Import

Run a full processing path from raw dynamic records to committed master-table records.

DataSynch → Pipeline Composer
Ideal for

GCP Application Integration, spreadsheet imports, connector feeds, and partner payloads.

Required context
  • manifestId
  • connectorId
  • sourceKind
  • records[]
Auth modes
  • x-api-key through API Gateway
  • App tenant auth
  1. 1
    Receive records

    Accept records from a connector, webhook, manual import, scanner, or internal source.

    /api/datasynch/integrations/receiver
  2. 2
    Normalize records

    Infer fields and normalize source values.

    /api/datasynch/processing/normalize
  3. 3
    Evaluate XREF rules

    Match source IDs and values against Atlas-controlled references.

    /api/datasynch/xref/evaluateOpen example
  4. 4
    Import accepted records

    Commit clean records to the selected master table.

    /api/datasynch/master-tables/importOpen example

Dispatch Webhook

Send a downstream webhook, email, Slack message, internal notification, or CSV export request.

DataSynch → Dispatch
Ideal for

Geofence events, exception rules, EDI status updates, and customer notifications.

Required context
  • manifestId
  • dispatchType
  • payload
Auth modes
  • x-api-key through API Gateway
  • App tenant auth
  1. 1
    Create source event or exception

    Use telemetry, geofence, processing, or exception routes as the trigger source.

  2. 2
    Dispatch notification

    Send the downstream action request.

    /api/datasynch/notification-dispatchOpen example
  3. 3
    Review logs

    Confirm queue, sent, failed, or skipped status.

    /api/datasynch/dispatch/logs

Check GCP Readiness

Confirm API Gateway and GCP Application Integration readiness before connecting live workflows.

DataSynch → Integrations → GCP
Ideal for

GCP setup, partner onboarding, and deployment checks.

Required context
  • API key or app admin auth
  • configured GCP project variables
Auth modes
  • x-api-key through API Gateway
  • Admin app auth
  1. 1
    Check API health

    Make sure the DataSynch service responds.

    /api/datasynch/healthOpen example
  2. 2
    Check Application Integration status

    Verify safe readiness flags and missing setup values.

    /api/datasynch/application-integration/statusOpen example
  3. 3
    Create or list integration profiles

    Confirm the manifest has reusable profile definitions.

    /api/datasynch/integrations/profiles