Lark Calendar icon

Lark Calendar

Lark Calendar Management

Overview

The "Lark Calendar" node provides integration with Lark's calendar service, enabling users to manage calendar data within their workflows. Specifically, the "Get Primary Calendar" operation retrieves the primary calendar associated with the authenticated user or tenant. This is useful for scenarios where you want to fetch the main calendar details before performing further actions like event creation, updates, or synchronization.

Practical examples include:

  • Automatically fetching the user's primary calendar ID to create events in it.
  • Synchronizing external calendar data by first identifying the primary calendar.
  • Displaying or logging primary calendar metadata as part of a workflow.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" (tenant-level API token) or "OAuth2".
Use Custom Body Boolean flag indicating whether to send a custom JSON body instead of the default request.
Custom Body A JSON object representing a custom request body to send if "Use Custom Body" is enabled.

Output

The node outputs JSON data representing the primary calendar's details as returned by the Lark Calendar API. This typically includes fields such as calendar ID, name, description, timezone, and other metadata describing the primary calendar.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication credential, either a tenant-level token or OAuth2 credentials configured in n8n.
  • The node makes HTTP requests to the Lark Suite Open APIs endpoint at https://open.larksuite.com/open-apis.
  • Proper permissions/scopes must be granted to the API credentials to access calendar information.

Troubleshooting

  • Authentication errors: Ensure that the provided API token or OAuth2 credentials are valid and have the necessary scopes to read calendar data.
  • Permission denied: The authenticated user or tenant might lack permission to access calendar information; verify roles and permissions in Lark Suite.
  • Invalid custom body: If using the "Custom Body" option, ensure the JSON is correctly formatted and matches the expected API schema.
  • Network issues: Confirm that n8n can reach the Lark Suite API endpoint without firewall or proxy blocking.

Links and References

Discussion