Documentation

Gorgias Advanced Action

Use the Gorgias Advanced Action module to call any Gorgias API endpoint from a flow by providing the endpoint path, HTTP method, and optional JSON body.

When to use this module

Use Gorgias Advanced Action when you need to call a Gorgias API endpoint that does not have a dedicated DigitalGenius module action.

This module is intended for advanced users. It uses the base URL from the module connection and appends the path you provide in the URL input.

Refer to the Gorgias API documentation for available endpoints and request body formats: Gorgias API reference.

Prerequisites

  1. Configure a Gorgias module connection in DigitalGenius.
  2. Confirm that the connection base URL points to the correct Gorgias API environment.
  3. Open the Gorgias API reference and identify the endpoint path, HTTP method, query parameters, and request body you want to use.

Configure the action

  1. Add the Gorgias Advanced Action module to your flow.
  2. Set URL to the Gorgias API path, including the leading slash and any query string.
  3. Set Method to the HTTP method required by the Gorgias endpoint.
  4. Set Data Object to the JSON request body when the endpoint requires one.
  5. Leave Data Object empty or pass null for requests that do not use a body, such as most GET requests.
  6. Use the module outputs to branch the flow based on whether the API call succeeded.

Inputs

InputIDTypeRequired value
URLurlStringPath appended to the module connection base URL. Include the leading slash and any query string.
MethodmethodStringHTTP method to use. Supported values are GET, POST, PUT, PATCH, and DELETE. The field may also display HEAD and OPTIONS as possible values.
Data ObjectdataObjectJSON payload to send as the request body. Use null or leave empty when the method has no request body.

URL format

The module builds the request URL by combining the connection base URL with the value from URL.

For example, this URL value:

/api/custom-fields?object_type=Ticket&archived=false&order_by=priority%3Aasc&limit=100

is appended to the configured Gorgias connection base URL.

Include the leading slash in the URL value. Query string values should be URL-encoded when required by the Gorgias API.

Example: retrieve custom fields

Use this configuration to call a Gorgias endpoint that returns custom fields for tickets.

FieldValue
URL/api/custom-fields?object_type=Ticket&archived=false&order_by=priority%3Aasc&limit=100
MethodGET
Data Objectnull

A successful request returns success as true, a 2xx response_code, and the parsed response body in response_data when the response is JSON.

Outputs

OutputIDTypeDescription
Success?successBooleantrue if the Gorgias API returned a 2xx status code. Otherwise, false.
Response Coderesponse_codeNumberHTTP status code returned by the Gorgias API.
Response Dataresponse_dataObjectResponse body. Parsed JSON when the body is JSON, raw text when the body is not JSON, or null when the response body is empty.
Error Messageerror_messageStringError description when the call fails or an exception occurs. Empty on success.

Handle the response in your flow

Use the Success? output to decide what happens next:

  1. If success is true, continue the flow using values from response_data.
  2. If success is false, inspect response_code and error_message.
  3. Add a fallback branch for non-2xx responses, empty response bodies, or unexpected response formats.

Troubleshooting

IssueWhat to check
The request fails before reaching GorgiasConfirm that the Gorgias module connection is configured and that the URL value starts with /.
success is falseCheck response_code to identify the HTTP status returned by Gorgias, then review error_message for details.
response_data is nullThe Gorgias API may have returned an empty response body. Use response_code and success to determine whether the request still completed successfully.
The endpoint rejects the request bodyConfirm that Data Object matches the JSON payload expected by the endpoint in the Gorgias API reference.
A GET request behaves unexpectedlyLeave Data Object empty or pass null, and put query parameters in the URL value.