Clay icon

Clay

Interact with Clay data enrichment platform
Join our community

Actions5

Overview

This node interacts with the Clay data enrichment platform, specifically focusing on operations related to Clay tables and workspaces. For the Table - Get Schema operation, it attempts to retrieve the schema and field definitions of a specified Clay table.

However, due to Clay API limitations, direct retrieval of table schemas is not supported. Instead, the node provides informational output explaining this limitation and suggests alternative ways to understand or obtain the table schema, such as viewing it within the Clay interface or exporting sample records.

This node is beneficial when you want to integrate Clay data workflows into n8n but need to be aware of the current API constraints around schema access. It helps automate record creation, updates, and lookups where supported, and for schema inspection, it guides users on manual alternatives.

Practical Example

  • You want to programmatically create or update records in a Clay table via webhook.
  • You want to find records by certain fields (though direct search is unsupported).
  • You want to get information about the table schema to map fields correctly, but since the API does not support this, you receive guidance on how to do it manually.

Properties

Name Meaning
Workspace Select your Clay workspace or enter workspace ID manually. This identifies which workspace contains the target table.
Workspace ID Manually enter the Clay workspace ID if not selecting from options. Found in the Clay URL: app.clay.com/workspaces/YOUR_ID.
Table Select your Clay table or enter table ID manually. Identifies the specific table within the workspace to operate on.
Table ID Manually enter the Clay table ID if not selecting from options. Found in the Clay URL: app.clay.com/workspaces/WS_ID/tables/TABLE_ID.

Output

The output JSON for the Get Schema operation includes:

  • success: Always false indicating the operation is not supported directly.
  • operation: "getSchema".
  • message: Explains that Clay API does not support direct table schema retrieval.
  • tableInfo: Contains the provided workspaceId and tableId.
  • alternatives: Suggestions on how to view or obtain schema information manually, e.g., viewing in Clay UI, exporting sample records, using field mapping in webhook setup.
  • recommendations: Tips on common Clay fields and best practices like case sensitivity and consistent naming.
  • documentation: Link to Clay's HTTP API integration overview.
  • timestamp: The time when the response was generated.

Example output JSON snippet:

{
  "success": false,
  "operation": "getSchema",
  "message": "Clay API does not support direct table schema retrieval",
  "tableInfo": {
    "workspaceId": "your_workspace_id",
    "tableId": "your_table_id"
  },
  "alternatives": [
    "View table schema within Clay interface",
    "Export a sample record to see field structure",
    "Use Clay's field mapping in webhook setup",
    "Document field names manually for consistent usage"
  ],
  "recommendations": [
    "Common Clay fields: First Name, Last Name, Email, Company, LinkedIn URL",
    "Field names are case-sensitive in webhook operations",
    "Use consistent field naming across your Clay tables"
  ],
  "documentation": "https://www.clay.com/university/guide/http-api-integration-overview",
  "timestamp": "2024-06-xxTxx:xx:xx.xxxZ"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Clay platform.
  • The node depends on the Clay API but note that some operations (including schema retrieval) are not supported by the API itself.
  • No additional external services are required beyond Clay.
  • Proper configuration of workspace and table IDs is necessary, either selected from loaded options or entered manually.

Troubleshooting

  • Common Issue: Attempting to get table schema returns a message that the API does not support this operation.

    • Resolution: Use the suggested alternatives such as viewing the schema inside the Clay web interface or exporting sample records.

  • Error: Invalid or missing workspace/table ID.

    • Resolution: Ensure correct workspace and table IDs are provided, either by selecting from dropdowns or entering them manually exactly as found in the Clay URLs.

  • Error: API request failures due to invalid credentials or network issues.

    • Resolution: Verify the API key credential is valid and has appropriate permissions. Check network connectivity.

  • Note: Since the schema retrieval is not supported, users should not expect dynamic schema data from this node and plan accordingly.

Links and References

Discussion