Actions32
- Calendar Actions
- Acl Actions
- Event Actions
- Event Attendee Actions
- Event Attendee Chat Member Actions
- Freebusy Actions
- Timeoff Actions
- Setting Actions
- Exchange Binding Actions
Overview
The "Subscribe To A Calendar" operation in the Lark Calendar node allows users to subscribe to a specific calendar by its ID. This subscription typically means that the user or application will receive updates or notifications related to events and changes on that calendar. It is useful for integrating calendar data into workflows, automating event tracking, or syncing calendar information with other systems.
Practical examples include:
- Automatically subscribing to a team calendar to get notified of new meetings.
- Syncing a project calendar with task management tools.
- Monitoring shared calendars for updates and triggering downstream automation.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests. Options: "Tenant Token" (using a tenant-level token) or "OAuth2" (using OAuth2 flow). |
| Calendar Id | The unique identifier of the calendar to subscribe to. Required to specify which calendar to subscribe to. |
| Use Custom Body | Boolean flag indicating whether to send a custom JSON body instead of the default request body. |
| Custom Body | A JSON object representing a custom request body to send if "Use Custom Body" is enabled. Allows advanced customization. |
Output
The node outputs JSON data representing the response from the Lark Calendar API after attempting to subscribe to the specified calendar. This typically includes confirmation details about the subscription status or any relevant metadata returned by the API.
If the API supports binary data in responses (not indicated here), it would be summarized accordingly, but this operation primarily deals with JSON data.
Dependencies
- Requires an active connection to the Lark Suite Open APIs.
- Needs either a valid tenant token credential or OAuth2 authentication configured in n8n.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper permissions/scopes must be granted to the credentials used to allow calendar subscription operations.
Troubleshooting
- Invalid Calendar Id: If the calendar ID is incorrect or does not exist, the API will return an error. Verify the calendar ID format and existence.
- Authentication Errors: Using expired or invalid tokens will cause authentication failures. Ensure credentials are up-to-date and have required scopes.
- Permission Denied: The authenticated user or app may lack permission to subscribe to the target calendar. Check access rights.
- Malformed Custom Body: If using a custom JSON body, ensure it is correctly formatted and matches the API's expected schema to avoid request errors.
- Network Issues: Connectivity problems can cause timeouts or failed requests. Confirm network access to the Lark API endpoint.
Links and References
- Lark Calendar API Documentation — For detailed API usage and calendar-related IDs.
- Lark Suite Developer Portal — For managing credentials and API keys.
- n8n Documentation on Credentials — Guidance on setting up authentication in n8n.