Lark Calendar icon

Lark Calendar

Lark Calendar Management

Actions32

Overview

The "Lark Calendar" node enables interaction with the Lark Calendar service, specifically allowing users to search for calendars within their Lark workspace. This operation is useful when you want to programmatically find calendars matching certain criteria or queries, such as retrieving all calendars containing a specific keyword in their title or description.

Common scenarios include:

  • Automating calendar discovery to integrate with other workflows.
  • Filtering calendars based on user input or dynamic conditions.
  • Preparing data for further operations like event creation or updates on selected calendars.

For example, you might use this node to search for all calendars related to "Marketing" projects and then create events on those calendars automatically.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: Tenant Token, OAuth2
Query A string query used to search for calendars matching the text
Custom Body A JSON object allowing full customization of the request body sent to the API
Use Custom Body Boolean flag indicating whether to send the custom JSON body instead of the default one

Output

The node outputs JSON data representing the search results from the Lark Calendar API. The json output field contains an array or collection of calendar objects that match the search query. Each calendar object typically includes details such as calendar ID, name, description, and other metadata provided by the Lark Calendar API.

If binary data were involved (not indicated here), it would represent attachments or files related to calendars, but this node focuses on JSON data only.

Dependencies

  • Requires access to the Lark Suite Open APIs.
  • Needs either a Tenant Token or OAuth2 authentication credential configured in n8n to authorize API requests.
  • The base URL for API requests is https://open.larksuite.com/open-apis.
  • Proper permissions/scopes must be granted to the credentials to perform calendar searches.

Troubleshooting

  • Authentication errors: Ensure that the chosen authentication method (Tenant Token or OAuth2) is correctly set up and valid. Expired tokens or insufficient scopes will cause failures.
  • Empty results: If no calendars are returned, verify the correctness of the query string or try removing filters to confirm calendars exist.
  • Invalid custom body: When using the "Custom Body" option, ensure the JSON structure matches the API specification; malformed JSON or incorrect fields will result in API errors.
  • Network issues: Confirm network connectivity to the Lark API endpoint and that no firewall or proxy blocks the requests.

Links and References

Discussion