CleverTap

Interact with CleverTap Public APIs

Actions3

Overview

This node allows users to interact with the CleverTap API, a platform for customer engagement and analytics. Specifically, the "Generic" resource with the "Request" operation enables making arbitrary HTTP requests (GET, POST, PUT, DELETE) to any CleverTap API endpoint by specifying the method, endpoint path, query parameters, and request body.

This flexibility is useful when you want to perform API calls that are not covered by predefined operations in the node, such as accessing new or less common CleverTap endpoints, testing API features, or integrating custom workflows.

Example use cases:

  • Sending a custom event or profile update using an endpoint not directly supported by the node.
  • Querying CleverTap data with specific filters via GET requests.
  • Deleting resources or configurations through DELETE requests.
  • Performing batch uploads or updates with POST or PUT methods.

Properties

Name Meaning
Method HTTP method to use for the request. Options: GET, POST, PUT, DELETE
Endpoint API path starting with "/", appended to the base CleverTap URL (e.g., "/1/upload")
Query Parameters Optional list of key-value pairs to include as URL query parameters in the request
Body JSON object representing the raw request body sent with POST or PUT requests

Output

The node outputs the JSON response returned by the CleverTap API call under the json field. The structure depends on the specific API endpoint called and the request made.

If the API returns binary data (not typical for CleverTap APIs), it would be handled accordingly, but this node primarily deals with JSON responses.

Dependencies

  • Requires an API authentication credential for CleverTap, including account ID and passcode.
  • The node uses these credentials to construct authenticated requests to the CleverTap API.
  • No additional external dependencies beyond standard HTTP request capabilities.

Troubleshooting

  • Invalid Credentials: If the API key or passcode is incorrect or missing, the node will fail to authenticate. Verify the configured credentials.
  • Incorrect Endpoint or Method: Using an invalid endpoint path or unsupported HTTP method may cause errors. Ensure the endpoint starts with "/" and matches CleverTap API documentation.
  • Malformed JSON Body: The "Body" property must be valid JSON. Invalid JSON syntax will cause parsing errors.
  • Query Parameter Issues: Duplicate or empty query parameter names might lead to unexpected API behavior.
  • API Rate Limits: Excessive requests may trigger rate limiting by CleverTap; handle such errors gracefully.
  • Error Handling: If "Continue On Fail" is enabled, errors will be output as JSON with an error message instead of stopping execution.

Links and References

Discussion