Guides
Authentication, keys and scopes
Every request carries a bearer key. Keys are created in Utilitay Account, under your organisation’s Developers tab. One product per key. Scopes and instance reach are fixed when the key is created; roll or revoke the key to change them.
Key anatomy
utl_live_k3Jh9QpL2mZx7VbN4cRt8WyS1dFg6HaU0eIo5PqA3zK1a2B3c
Prefix
utl_live_ · identifies the key type
Body
43 random characters
Checksum
6 characters · catches typos before a request
Send it as Authorization: Bearer utl_live_…, in the header only: a key in a query string is not read. The key is shown once, when it is made.
Scopes
Scopes name the wire, not the pack. A key with subjects:write can create subscriptions in a Subscription business instance and students in a High school one.
contacts:readList and read customers and links
contacts:writeCreate, update, deactivate customers; create links
subjects:readList and read subscriptions
subjects:writeCreate, update, deactivate subscriptions
events:readList and read events and event types
events:writeRecord and void events
messages:readRead the messages rules produced
There is no messages:write. Messages are produced by rules when you post events. GET /messages is read only.