- Documents — list, search, fetch content
- Clients (FYI calls them entities) — read, search
- Jobs — read, create, update job state
Prerequisites
- An FYI subscription (Australia or UK region)
- An FYI administrator login to create the API application
Get your credentials from FYI
- Sign in to FYI
- Go to Automations → API
- Click Create New API Application and name it
DeskMate - Copy the Access ID and Access Secret — the secret is shown once, so copy it immediately
Connect
- In DeskMate, open Workspace → Connectors
- Click Connect on the FYI Docs tile
- Pick your Region — Australia (
ap-southeast-2) or United Kingdom (eu-west-2) - Pick your Environment — Production, unless FYI support told you to use Staging
- Paste the Access ID and Access Secret
- Application ID is only needed for FYI App Store integrations — leave it blank otherwise
- Click Connect — DeskMate validates the keys against FYI before saving

