Feishu Node icon

Feishu Node

Feishu Node

Actions106

Overview

This node integrates with a calendar service to search for events within a specified calendar. It allows users to perform keyword-based searches on event names, supporting both fuzzy and exact matching depending on the presence of underscores in the event names. The node supports pagination to handle large result sets and offers filtering capabilities through a JSON filter object.

Common scenarios include:

  • Finding specific meetings or appointments by keywords.
  • Retrieving upcoming or past events that match certain criteria.
  • Integrating calendar event search into automated workflows, such as syncing events with other systems or triggering actions based on event data.

Practical example:

  • A user wants to find all events containing the word "Project" in their title within a particular calendar to generate a report or send reminders.

Properties

Name Meaning
日历 ID The unique identifier of the calendar to search within. Can be obtained via APIs that list calendars or retrieve main calendar info.
搜索关键字 The keyword used to search event names. Supports fuzzy matching unless the event name contains an underscore (_), in which case an exact match is required.
搜索过滤器(filter对象) A JSON object specifying additional filters for the search query. Refer to the official API documentation for supported filter fields and structure.
分页标记 Token used for paginated requests. Leave empty on the first request. If more results are available, the response will include a new token to fetch subsequent pages.
每页数量 Maximum number of events returned per call. Minimum is 10, maximum is 100. Controls the page size for pagination.
用户 ID 类型 Specifies the type of user ID used in the request. Options are: Open ID, Union ID, or User ID. This affects how user identifiers are interpreted in the context of the search operation.

Output

The node outputs an array of JSON objects representing calendar events that match the search criteria. Each item corresponds to one event and includes details such as event name, time, participants, and other metadata as provided by the calendar API.

If binary data is present (not indicated explicitly here), it would typically represent attachments or related files associated with events, but this node primarily focuses on JSON event data.

Dependencies

  • Requires an API key credential for authenticating with the calendar service.
  • Needs proper configuration of credentials within n8n to access the calendar API.
  • Relies on the external calendar API endpoint for searching events, including support for pagination and filtering.

Troubleshooting

  • Empty results: Ensure the calendar ID is correct and the search keyword matches existing event names. Remember that underscores in event names require exact keyword matching.
  • Pagination issues: If you receive a page_token in the response, use it in subsequent requests to fetch all results. Omitting this may lead to incomplete data retrieval.
  • Invalid filter JSON: The filter property must be a valid JSON object following the API specification. Malformed JSON will cause errors.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to access the calendar data.
  • Error messages: Errors from the API will be surfaced; check the error message for details such as invalid parameters or permission issues. Adjust inputs accordingly.

Links and References

Discussion