Skip to navigation

Supports:

  • ✅ Models
  • ✅ Bulk sync source
  • ✅ Connection Proxy

Connection

Configuration

NameTypeDescriptionRequired
auth_methodstringAuthentication method

Accepted values: api_key ↓, private_app ↓
required
domainstringDomain

Your Gorgias subdomain (e.g. ‘acme’ for acme.gorgias.com)
required

auth_method

When auth_method is api_key:

NameTypeDescriptionRequired
apikeystringAPI keyrequired
emailstringEmail

Your Gorgias account email address
required
{
"name": "Gorgias connection",
"type": "gorgias",
"configuration": {
"apikey": "secret-key",
"auth_method": "api_key",
"domain": "acme",
"email": "user@example.com"
}
}

When auth_method is private_app:

NameTypeDescriptionRequired
client_idstringClient IDrequired
client_secretstringClient secretrequired
{
"name": "Gorgias connection",
"type": "gorgias",
"configuration": {
"auth_method": "private_app",
"client_id": "6218fa8cfe1b2a3c4d5e6f70",
"client_secret": "secret",
"domain": "acme"
}
}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
objectstringObjectrequired

Example

{
...
"configuration": {
"object": "object"
}
}

Bulk Sync

Source

Gorgias connections may be used as a bulk sync source. No additional configuration options are required.