Gladly icon

Gladly

Interact with Gladly API

Overview

This node allows users to search for public answers within an organization using the Gladly API. It is useful in scenarios where you want to programmatically retrieve knowledge base articles or FAQs related to specific queries, helping automate customer support workflows or integrate searchable help content into other systems.

For example, a support team could use this node to fetch relevant answers about password resets or account issues based on user input, enabling quick access to helpful information without manual searching.

Properties

Name Meaning
Org Id The unique identifier of your organization. You can find this ID via the organization's API or management interface.
Q The search term or query string used to find matching public answers.
Lng The language code specifying the language of the answers to be searched (e.g., "en-us" for English - United States).
Audience Id The audience identifier to filter answers by a specific audience segment. This ID is found in the Gladly settings under Audiences.

Output

The node outputs JSON data containing the search results from the Gladly public answers endpoint. Each item in the output typically represents an answer matching the search criteria, including details such as the answer content, metadata, and possibly identifiers.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Gladly API.
  • The node uses the Gladly API base URL https://petstore3.swagger.io/api/v3 (likely a placeholder in the bundled code).
  • Proper configuration of the API key credential in n8n is necessary for successful requests.

Troubleshooting

  • Common Issues:
    • Invalid or missing organization ID will result in no or failed search results.
    • Incorrect or expired API credentials will cause authentication errors.
    • Using unsupported or incorrect language codes or audience IDs may yield empty results.
  • Error Messages:
    • Authentication failures usually indicate invalid API keys; verify and update credentials.
    • 404 or resource not found errors suggest incorrect Org Id or Audience Id.
    • Network or timeout errors may require checking connectivity or API availability.

Links and References

  • Gladly API Documentation (for organization and audience ID lookup): https://docs.gladly.com/
  • Gladly Settings > Audiences (to find Audience Id)
  • n8n documentation on API credentials and HTTP Request nodes for further customization

Discussion