Skip to main content
A custom Object pairs an entity in your system with a permanent scan URL of the form https://award.ee/o/{public_slug}. This page is the field-by-field reference for the wire format returned by every objects endpoint.

​
Identifiers

​
object
string
required
Always "object". Sentinel that identifies the resource type on responses.
​
id
string
required
Bare UUID. Stable for the lifetime of the row.
​
type
string
required
Free-form category you control: "vehicle", "ticket", "asset", "contact", etc. Letters, numbers, and hyphens only (1–64 chars). Used as a namespace in variable substitution ({{object.<type>.<key>}}).
​
external_id
string | null
Your identifier. Unique per (org_id, external_id). Pass it on POST for idempotent upsert. null for objects created without one.
​
public_slug
string
required
Short opaque slug minted on insert. Used to build the scan URL. Immutable, and never reused after delete.
​
url
string
required
Full scan URL, e.g. https://award.ee/o/a1b2c3d. Derived from public_slug — included as a convenience so you don’t have to build it.
​
name
string | null
Human-readable label. Shown in the dashboard. Not displayed to scan visitors by default.
​
description
string | null
Free-form description. Internal-only.
​
metadata
object
required
Free-form JSON blob you own. Use it to stash CRM context, attributes, or anything else integration-specific. Defaults to {}. Not searchable.

​
Destination

​
destination
object
required
Where the scan URL routes. Exactly one of the companion fields should be populated for each type.

​
State

​
is_active
boolean
required
Master switch. When false, the scan URL still resolves but is treated as paused.

​
Stats

​
total_scans
number
required
All-time scan count for the row. Increments in real time.
​
last_scanned_at
string | null
RFC 3339 timestamp of the most recent scan. null if never scanned.

​
Timestamps

​
created_at
string
required
RFC 3339 creation timestamp.
​
updated_at
string
required
RFC 3339 timestamp of the last update to this row.

​
Example

{
  "object": "object",
  "id": "3a00bde3-f3b3-44a9-a16b-5d694e145440",
  "type": "vehicle",
  "external_id": "VIN-1HGCM82633A123456",
  "public_slug": "a1b2c3d",
  "url": "https://award.ee/o/a1b2c3d",
  "name": "2024 Toyota Hilux",
  "description": "Fleet truck assigned to depot 3.",
  "metadata": {
    "color": "blue",
    "fleet": 3,
    "year": 2024
  },
  "destination": {
    "type": "chatbot",
    "chatbot": "8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e",
    "page": null,
    "knowledge_base": null,
    "url": null
  },
  "is_active": true,
  "total_scans": 127,
  "last_scanned_at": "2026-05-23T09:58:21Z",
  "created_at": "2026-05-01T08:00:00Z",
  "updated_at": "2026-05-23T09:58:21Z"
}

​
Sub-resources

Properties and URL params live at their own endpoints and have their own reference shape: 
{
  "id": "f0e9d8c7-b6a5-4f3e-2d1c-0b9a8c7d6e5f",
  "key": "color",
  "value": "blue",
  "sort_order": 0,
  "created_at": "2026-05-01T08:00:00Z",
  "updated_at": "2026-05-23T09:58:21Z"
}