Surense icon

Surense

Interact with Surense API

Actions36

Report → Send a Report

AI-generated

Overview

The node named "Surense" provides integration with the Surense API, allowing users to interact with various resources such as activities, contacts, customers, reports, and more. Specifically, for the Report resource and the Send a Report operation, this node enables sending a report identified by its unique ID to a specified customer. This can be useful in scenarios where automated report distribution is needed, such as sending performance summaries, billing statements, or analytics reports directly to clients via email or SMS.

Practical examples include:

  • Automatically sending monthly financial reports to customers.
  • Dispatching incident or audit reports to stakeholders.
  • Delivering marketing or sales reports to clients based on their preferences.

Properties

Name Meaning
מזהה לקוח (customerId) Customer ID in UUID format identifying the recipient of the report.
מזהה דוח (reportId) Report ID in UUID format specifying which report to send.
Additional Parameters Optional parameters to customize the sending method:
- מספר פלאפון (cellNumber) Cell phone number to send the report via SMS (e.g., +972502333327).
- מייל (email) Email address to send the report via email.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output JSON object contains the result of the send report operation, typically including success confirmation or error details if the operation failed.

If the operation encounters an error and the node is configured to continue on failure, the output will include an error field describing the issue for that particular item.

No binary data output is indicated in the source code.

Dependencies

  • Requires an active connection to the Surense API using OAuth2 authentication.
  • The node depends on the Surense API credentials configured in n8n.
  • No additional external services are explicitly required beyond the Surense API.

Troubleshooting

  • Common issues:

    • Invalid or missing customer ID or report ID (must be valid UUIDs).
    • Incorrect or missing contact information in additional parameters (phone number or email).
    • Authentication failures due to invalid or expired API tokens.
    • Network connectivity issues preventing access to the Surense API.

  • Error messages:

    • Errors thrown during execution will contain descriptive messages from the API or internal validation.
    • If "Continue On Fail" is enabled, errors for individual items will appear in the output JSON under an error key.

  • Resolutions:

    • Verify that all required fields are correctly filled with valid UUIDs.
    • Ensure the provided email and phone number formats are correct.
    • Check and refresh API credentials if authentication errors occur.
    • Confirm network connectivity and API endpoint availability.

Links and References

Discussion