Gladly icon

Gladly

Interact with Gladly API

Overview

This node interacts with the Gladly API to retrieve a specific custom attribute related to "Freeform Topics." It is designed to fetch detailed information about a custom attribute by its unique identifier. This functionality is useful when you need to dynamically access metadata or configuration details stored as custom attributes within the Gladly system.

Practical examples include:

  • Retrieving a custom attribute to display or use in subsequent workflow steps.
  • Validating or processing data based on custom attribute values.
  • Integrating Gladly's custom attribute data into other systems or reports.

Properties

Name Meaning
Custom Attribute Id The unique identifier of the custom attribute to retrieve.

Output

The node outputs JSON data representing the details of the requested custom attribute. The structure typically includes fields describing the attribute's properties such as its id, name, type, value, and any associated metadata defined by the Gladly API.

If the node supports binary data output, it would represent any file or media content linked to the custom attribute, but based on the provided code and operation, the output is primarily JSON.

Dependencies

  • Requires an API key credential for authenticating with the Gladly API.
  • The base URL for API requests is set to https://petstore3.swagger.io/api/v3 (likely a placeholder).
  • Uses an OpenAPI specification (openapi.json) bundled with the node to define available operations and properties.

Troubleshooting

  • Invalid Custom Attribute Id: If the provided ID does not exist or is malformed, the API will likely return an error. Verify the ID before running the node.
  • Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Check connectivity to the Gladly API endpoint.
  • Unexpected Response Structure: If the API changes, the node might fail to parse the response correctly. Updating the OpenAPI spec or node version may be necessary.

Links and References

Discussion