DocsTools
Gorgias
Tickets, customers, replies and macros.
- Category
- Customer support
- How you connect
- API key or token. You paste a key or token from the tool. Homla stores it encrypted and never shows it again.
- Time to set up
- About 4 minutes
- Actions
- 5 read, 4 write
Connect it#
In Homla, open Connectors, then Gorgias. The Setup guide button walks you through the same steps, with fields to paste into.
Who can do it. Only the Account Owner or an Admin can create a Gorgias REST API key. The key belongs to the user who creates it and carries that user's full role, so every reply, note, tag and status change Homla makes shows under that user's name.
Recommended. Invite a dedicated user such as wedge-bot@yourcompany.com with the Admin role (only Admins can mint keys), accept the invitation, sign in as it and create the key there. Gorgias prices by tickets, not seats, so this user is free on every plan except Starter, which is capped at 3 users. Homla's writes are then attributed to wedge-bot in Gorgias, and you can cut Homla off without touching anyone's access.
- Invite a wedge-bot Admin userSigned in as the Account Owner or an Admin, open Users, click Add user, enter wedge-bot@yourcompany.com, pick the Admin role and send the invitation. Accept it from that inbox and set a password. Skip this step only if you accept that Homla's actions show under your own name.
The invitation expires after 7 days.
- Open the REST API page as wedge-botSigned in as wedge-bot. The same page opens from the Settings icon, bottom left > Account > REST API. It shows the Base API URL, the Username (the user's email) and the Password (API Key).
- Create and copy the API keyUnder Password (API Key), click Create API Key, then Copy. The key stays readable on this page for its owner, but treat it like a password: paste it only into Homla.
The key has no scopes: it can do everything its user's Admin role can. Homla limits it per person with tool grants and read-only roles; Gorgias itself cannot.
- Paste the three values into HomlaIn Homla, open Connectors, then Gorgias, then Connect an account. Fill domain with your subdomain (acme for acme.gorgias.com), email with the Username shown on the REST API page (wedge-bot's email), and api_key with the key. Click Add account. Homla encrypts them and never shows them again. Open it.
The email must be the key owner's email exactly; a key paired with another user's email is refused.
- Decide who may writeGorgias keys cannot be made read-only. For people who should only read, grant them the read tools in Homla (or a read-only role): gorgias_tickets_list, gorgias_ticket_get, gorgias_customer_get, gorgias_macros_list, gorgias_directory_list. Keep gorgias_ticket_reply (it emails customers) for the people who answer tickets. Open it.
What your AI can do#
These are the actions Homla gives your AI. Your role decides which ones you get. Write actions are a dry run until confirmed, see Approvals and dry runs.
Read#
Looks things up, never changes anything.
| Action | What it does |
|---|---|
gorgias_tickets_list | List tickets, newest activity first. |
gorgias_ticket_get | One ticket with its conversation: customer, status, tags, assignee, and messages (text, sender, internal notes flagged). |
gorgias_customer_get | Find a customer by email, id or free text (name, phone, any address). |
gorgias_macros_list | List saved macros (reply templates) with their actions and reply text. |
gorgias_directory_list | List helpdesk reference data: users (agents), teams, views, tags, integrations (channels) or custom_fields. |
Write#
Creates or changes things, as the account owner.
| Action | What it does |
|---|---|
gorgias_ticket_create Deletes | Open a ticket. |
gorgias_ticket_reply Deletes | Reply on a ticket. |
gorgias_ticket_update | Change a ticket: status, priority, assignee, team, subject, snooze, spam, trash. |
gorgias_request | Any Gorgias REST call for routes without a tool (rules, surveys, events, jobs, deletes...). |
Disconnect it#
In Homla, open the account menu on the tool's page and choose Disconnect. Anyone it was shared with loses access at once. To cut it off on the tool's side too:
To cut Homla off at once, sign in as wedge-bot, click Reset next to Password (API Key) and confirm with OK, then do not paste the new key anywhere; or deactivate the wedge-bot user from the Users page. Reset invalidates the old key immediately. To rotate, reset and paste the new key into the same Homla form.
Generated from the product code. Action names are what the CLI and the API use.