Feishu Node icon

Feishu Node

Feishu Node

Overview

This node interacts with the Feishu (Lark) calendar API to retrieve a list of events from a specified calendar. It is designed for scenarios where users need to automate the extraction of calendar event data, such as syncing events to other systems, generating reports, or monitoring schedules within workflows.

Practical examples:

  • Syncing Feishu calendar events to Google Calendar or Outlook.
  • Generating daily or weekly event summaries for team dashboards.
  • Triggering notifications or actions based on upcoming events.

Properties

Name Type Meaning
日历 ID string The unique identifier of the calendar. Obtainable via main calendar info, calendar list, or search APIs.
每页数量 number Maximum number of events to return per request (range: 50–1000).
分页标记 string Pagination token; leave empty for the first request. Used for fetching subsequent pages of results.
时间锚点 string Anchor time as a Unix timestamp (seconds). Fetches events after this point in time.
增量同步标记 string Sync token for incremental updates. Leave empty for the first request; use returned value for next sync.
开始时间 string Start time of the interval (Unix timestamp, seconds). Use with end time to specify a range.
结束时间 string End time of the interval (Unix timestamp, seconds). Use with start time to specify a range.
用户 ID 类型 options Type of user ID used (Open ID, Union ID, or User ID).

Output

The node outputs an array of objects under the json field for each input item. Each object represents a calendar event or error information if the operation fails for that item.

  • Success:
    Each output item contains the event data as returned by the Feishu API. The structure typically includes fields like event ID, summary, start and end times, attendees, etc., depending on the Feishu API response.

  • Error Handling:
    If an error occurs and "Continue On Fail" is enabled, the output will include:

    {
      "error": "Error message here"
    }
    

    For API errors, additional details may be included under the error key.

Dependencies

  • External Service: Requires access to the Feishu (Lark) API.
  • Credentials: Needs valid Feishu API credentials configured in n8n (feishuCredentialsApi).
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

  • Common Issues:

    • Invalid Credentials: Ensure Feishu API credentials are correctly set up in n8n.
    • Missing Required Fields: The "日历 ID" property is mandatory; omitting it will cause errors.
    • API Rate Limits: Excessive requests may trigger rate limiting by Feishu.
    • Incorrect Time Format: "开始时间", "结束时间", and "时间锚点" must be Unix timestamps in seconds.
  • Error Messages:

    • "未实现方法: calendar.calendar:listEvents": Indicates the requested resource/operation combination is not implemented.
    • "NodeApiError": Returned when the Feishu API responds with an error. Check the error field for more details.
    • Other errors will include a descriptive message in the error field of the output.

Links and References

Discussion