Gorgias Integration Testing

3 min read

This guide covers how to validate the Gorgias integration on the Composio Developer Platform — a direct tool-execution interface for testing auth, reads, writes, and error handling.

Pre-requisites

  • A Composio account

  • A Gorgias account (Admin or Manager access)

  • A modern browser: Chrome, Firefox, or Edge

  • Internet access

Optional test data in Gorgias:

  • 1–2 demo support tickets (e.g., "Test Ticket 1")

  • 1–2 customers (e.g., "John Doe")

Step 1 — Sign Up & Log In

Step 2 — Add the Gorgias Integration

  1. Click All Toolkits (top-right navigation).

  2. Search for Gorgias in the toolkit library.

  3. Select Gorgias → click Add to Project.

  4. Click Create Gorgias Auth Config using Composio-managed OAuth (no Gorgias app needed; name it e.g., "Gorgias-Test-Org"). For your own OAuth credentials, see the Gorgias OAuth credential guide.

Composio Auth Configs - Gorgias (OAuth2)Composio Gorgias auth config with Connect Account

Step 3 — Connect Gorgias Account (OAuth2)

  1. Open the Tools & Trigger Types tab.

  2. Pick an easy read action for the first run (recommended: List Tickets — GORGIAS_LIST_TICKETS).

  3. Click Execute Tool.

  4. Select Connected Account → Connect an account.

  5. In the Gorgias OAuth pop-up: choose your Gorgias organization → Allow access.

  6. Back in Composio: Continue → Execute Tool to verify the connection.

Composio Connect to Gorgias - enter subdomain

Step 4 — Validate Read Operations

Run the following to confirm basic access:

  • List Tickets (GORGIAS_LIST_TICKETS) — returns all tickets or filtered by status, assignee, etc.

  • List Customers (GORGIAS_LIST_CUSTOMERS) — optionally filter by name.

  • List Ticket Tags (GORGIAS_LIST_TICKET_TAGS) — check ticket metadata.

NOTE: The Gorgias toolkit does not expose a ticket comments/messages read tool, so the original "Get Ticket Comments" check is covered here by GORGIAS_LIST_TICKET_TAGS as an additional read.

Step 5 — Validate Write Operations

Prepare minimal payloads and execute:

  • Create Ticket (GORGIAS_CREATE_TICKET)

    • Subject: Test Ticket 1

    • Description: This is a test ticket created via Composio

    • Status: open

    • Priority: low

  • Add Ticket Tags (GORGIAS_ADD_TICKET_TAGS) — tag the ticket you just created.

  • Get Ticket (GORGIAS_GET_TICKET) by ID to confirm persisted data.

  • Update Ticket (optional) (GORGIAS_UPDATE_TICKET) — change the status to resolved.

NOTE: The Gorgias toolkit has no add-comment/message tool, so the original "Add Comment to Ticket" step is replaced with GORGIAS_ADD_TICKET_TAGS to validate a write path.

Step 6 — Re-auth & Persistence Checks

  • Sign out of Composio, sign back in, and return to the project.

  • Re-run List Tickets (GORGIAS_LIST_TICKETS) to confirm the connected account persists.

  • (Optional) In Gorgias, revoke app access, then attempt any read → expect an auth error → reconnect to confirm recovery.

Testing Checklist

Platform Setup

  • ☐ Log in to Composio

  • ☐ Add the Gorgias toolkit to the project

  • ☐ Complete Gorgias OAuth and connect an organization

  • ☐ Connection persists across sessions

Read / Write Coverage

  • ☐ List Tickets succeeds

  • ☐ List Customers succeeds

  • ☐ List Ticket Tags succeeds

  • ☐ Create Ticket succeeds (visible in Gorgias)

  • ☐ Add Ticket Tags succeeds and is visible on the ticket

  • ☐ (Optional) Update Ticket / change status

Reliability & Security

  • ☐ Errors from Gorgias (e.g., invalid status, missing customer) surface clearly in Composio

  • ☐ Least-privilege scopes requested; OAuth consent shows the Gorgias org

  • ☐ No unnecessary data persisted; actions performed on behalf of the authenticated user only

Demo Resources

  • Live Testing: Composio Platform

  • (Optional) Video Walkthrough: a short screencast of the steps above can be provided for reviewers.

Notes for Reviewers

  • Composio acts as a secure orchestration layer; it stores only what's required for auth and execution.

  • All actions run with the connected user's permissions; no bulk ingestion without explicit user action.

  • Each tool action in the Tools & Trigger Types tab can be executed with sample payloads to validate request/response shapes and error handling.

  • Please test both read (tickets, customers, ticket tags) and write (create ticket, add tags) paths.

  • Error handling: try an invalid ticket status or a missing customer on ticket creation to confirm surfaced Gorgias errors match API semantics.

Contact: hello@composio.dev for technical questions during review.

Share