Surense icon

Surense

Interact with Surense API

Actions36

Activity → Create an Activity

AI-generated

Overview

The node integrates with the Surense API to perform various operations on different resources. Specifically, for the Activity resource and the Create an Activity operation, it allows users to create a new activity by submitting HTML content along with optional related entity IDs such as customer, employer, lead, meeting, or workflow identifiers. This is useful in scenarios where you want to log or track activities linked to these entities within the Surense platform.

Practical examples include:

  • Logging a customer interaction note with rich HTML formatting.
  • Creating an activity record tied to a specific meeting or lead.
  • Tracking workflow-related events by associating activities with workflow IDs.

Properties

Name Meaning
HTML Content The main content of the activity in HTML format. Required field.
Additional Parameters Optional collection of parameters to associate the activity with other entities:
- Customer ID UUID string identifying a customer to link the activity to.
- Employer ID UUID string identifying an employer to link the activity to.
- Lead ID UUID string identifying a lead to link the activity to.
- Meeting ID UUID string identifying a meeting to link the activity to.
- Workflow ID UUID string identifying a workflow to link the activity to.

Output

The node outputs JSON data representing the created activity object returned from the Surense API. This typically includes details such as the activity's unique identifier, timestamps, associated entity IDs, and the HTML content submitted.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an active connection to the Surense API using OAuth2 authentication (configured via n8n credentials).
  • The node depends on internal helper modules for operation execution and pagination but primarily interacts with the Surense API endpoints.
  • No additional environment variables are explicitly required beyond the API credential setup.

Troubleshooting

  • Common issues:
    • Invalid or missing UUIDs in additional parameters may cause API errors.
    • Missing required "HTML Content" will likely result in validation errors.
    • Authentication failures if the OAuth2 token is expired or misconfigured.
  • Error messages:
    • Errors returned from the Surense API will be propagated; typical messages might include invalid parameter formats or unauthorized access.
    • If continueOnFail is enabled, errors for individual items will be returned in the output JSON under an error field for easier debugging.
  • Resolutions:
    • Ensure all UUIDs follow the correct format.
    • Verify OAuth2 credentials and refresh tokens if necessary.
    • Provide valid HTML content in the required field.

Links and References

Discussion