Feishu Node icon

Feishu Node

Feishu Node

Actions61

Overview

This node enables searching for calendar events in Feishu (Lark) calendars. It is designed to help users find specific events by keyword, filter, and other criteria within a given calendar. Common scenarios include:

  • Locating meetings or appointments by name or keyword.
  • Filtering events based on custom conditions (e.g., time range, organizer).
  • Paginating through large sets of calendar events.

Practical examples:

  • A workflow that automatically finds all upcoming team meetings containing "Sprint" in the title.
  • Searching for all events organized by a specific user within a certain date range.

Properties

Name Type Meaning
日历 ID String The unique identifier of the calendar to search. Obtainable via main calendar info, calendar list, or calendar search APIs.
搜索关键字 String Keyword for fuzzy search on event names. If the event name contains an underscore (_), an exact match is required.
搜索过滤器(filter对象) JSON Additional filter object for advanced queries. See Feishu API docs.
分页标记 String Pagination token. Leave empty for the first request; use the returned value for subsequent pages.
每页数量 Number Maximum number of events per call (min: 10, max: 100, default: 20).
用户 ID 类型 Options Type of user ID used (Open ID, Union ID, User ID).

Output

The node outputs a JSON array where each item represents a calendar event matching the search criteria. Each output item includes the event's details as provided by the Feishu API. If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

Example output structure:

[
  {
    "event_id": "string",
    "summary": "Event Title",
    "start_time": "2024-06-01T09:00:00Z",
    "end_time": "2024-06-01T10:00:00Z",
    // ...other event fields from Feishu API
  }
]

If an error occurs:

[
  {
    "error": "Error message here"
  }
]

Dependencies

  • External Service: Requires access to the Feishu (Lark) Calendar API.
  • Credentials: Needs n8n credentials named feishuCredentialsApi.
  • Environment: No special environment variables are required beyond standard n8n setup.

Troubleshooting

  • Missing Credentials: If credentials are not configured, the node will fail to authenticate.
  • Invalid Calendar ID: Supplying an incorrect or inaccessible calendar ID will result in an error.
  • API Errors: Errors from the Feishu API (such as invalid filters or exceeding rate limits) will be reported in the output if "Continue On Fail" is enabled, or will stop execution otherwise.
  • Common Error Messages:
    • 未实现方法: calendar.calendar:searchEvents: Indicates the selected resource/operation combination is not implemented.
    • NodeApiError: Usually means an issue with the API response; check the error details for more information.

Links and References

Discussion