Lark Calendar icon

Lark Calendar

Lark Calendar Management

Actions32

Overview

The "Create An Event" operation in the Lark Calendar node allows users to create new calendar events within a specified calendar. This is useful for automating scheduling tasks, such as adding meetings, reminders, or appointments programmatically. Typical scenarios include syncing events from other systems, setting up automated notifications, or batch-creating events based on external triggers.

For example, you could use this node to automatically add a team meeting event with specific attendees, location, and video conferencing details whenever a new project is started in your project management tool.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Calendar Id The unique identifier of the calendar where the event will be created.
Attendee Ability Permissions or abilities assigned to attendees (e.g., whether they can modify the event).
Color Numeric value representing the color code of the event for visual categorization.
Description Text description or notes about the event.
End Time Object specifying the event's end time, including date, timestamp, and timezone.
Free Busy Status Status indicating availability during the event (e.g., free, busy).
Location Object describing the event location, including address, latitude, longitude, and name.
Need Notification Boolean flag indicating whether notifications should be sent for the event.
Recurrence String defining recurrence rules if the event repeats (e.g., daily, weekly).
Reminders Array of reminder objects, each specifying how many minutes before the event a reminder should trigger.
Schemas Array of schema objects containing UI-related metadata like app_link, ui_name, and ui_status.
Start Time Object specifying the event's start time, including date, timestamp, and timezone.
Summary Title or summary text of the event.
Vchat Object with video chat details, including description, icon_type, meeting_url, and vc_type (video conference type).
Visibility String indicating the visibility level of the event (e.g., public, private).
Custom Body JSON object allowing users to provide a fully custom request body instead of using individual properties.
Options > Use Custom Body Boolean option to toggle between using the standard input properties or sending a custom JSON body.

Output

The node outputs the created event data in the json field of the output item. This typically includes all details of the newly created event as returned by the Lark Calendar API, such as event ID, timestamps, attendees, location, and any other metadata.

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

Dependencies

  • Requires an active connection to the Lark Suite API.
  • Supports two authentication methods: a tenant token or OAuth2 credentials.
  • The node must be configured with appropriate API credentials that have permissions to create calendar events.
  • Network access to https://open.larksuite.com/open-apis is required.

Troubleshooting

  • Missing or invalid Calendar Id: The calendar ID is mandatory; ensure it is correctly provided and corresponds to an existing calendar accessible by the authenticated user.
  • Authentication errors: Verify that the selected authentication method is properly configured and the credentials are valid.
  • Invalid date/time formats: The start and end times require correct formatting with date, timestamp, and timezone fields. Incorrect formats may cause API errors.
  • Permission issues: The authenticated user or token must have rights to create events in the target calendar.
  • Using Custom Body: When enabling the custom body option, ensure the JSON structure matches the API requirements exactly; malformed JSON or missing required fields will cause failures.

Links and References

Discussion