FeiShu

1. Overview

Feishu (also known as Lark) is an all-in-one platform for collaboration that brings together messaging, video conferencing, calendar, and documents in a single, easy-to-use application. It is designed to enhance team productivity and streamline workflows.

With the GoInsight Feishu node, you can seamlessly integrate Feishu's powerful collaboration tools into your automated workflows. This enables you to manage various aspects of your Feishu workspace, including:

• Communication: Send messages and urgent notifications, and manage chat groups and their members.
• Calendar and Events: Create, update, delete, and manage calendars and events, including handling attendees.
• Contact and Organization: Manage users and organizational departments, retrieving information and searching for contacts.
• Cloud Documents: Create and manage Feishu Docs and Drive folders, automating your content workflows.

2. Prerequisites

Before using this node, you must have an active Feishu account with the necessary permissions to create and manage apps. You will need to create a custom app within your Feishu tenant to obtain the App ID and App Secret required for credentials.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

The Feishu node allows you to interact with various resources like Calendars, Events, Chats, Departments, Users, Drive, Documents, and Messages. The following summary table outlines the supported operations.

Summary

Operation Details

Create Calendar

Creates a new calendar with the specified name and optional description.

Input Parameters

• Summary: Name/title of the calendar to be created (required).

Options

• Description: Description of the calendar.

Output

• Data (object): Response data containing created calendar information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Delete Calendar

Deletes a specified calendar by its calendar ID. This action cannot be undone.

Input Parameters

• CalendarId: ID of the calendar to be deleted (required).

Output

• Data (object): Response data containing deletion confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Calendar

Retrieves detailed information about a specific calendar by its calendar ID.

Options

• CalendarId: Calendar ID to retrieve information for (default: "primary").

Output

• Data (object): Response data containing calendar information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

List Calendars

Retrieves a list of calendars accessible to the authenticated user with pagination support.

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of calendars to return per page (1-500, default: 50).

Output

• Data (object): Response data containing calendar list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Search Calendars

Searches for calendars based on a query string, supporting fuzzy matching of calendar names.

Input Parameters

• Query: Search query string for fuzzy matching calendar names (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of calendars to return per page (1-100, default: 20).

Output

• Data (object): Response data containing search results.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Update Calendar

Updates the properties of an existing calendar, such as its name and description.

Input Parameters

• CalendarId: ID of the calendar to be updated (required).

Options

• Summary: New name/title for the calendar.
• Description: New description for the calendar.

Output

• Data (object): Response data containing updated calendar information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Add Members to Chat

Add users or bots to a Feishu chat group.

Input Parameters

• ChatId: ID of the chat group to add members to (required).
• Members: List of user IDs or bot IDs to add to the chat group (required).

Options

• MemberIdType: Type of ID for the members to add (default: "open_id").

Output

• Data (object): Response data containing addition confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Create Chat

Create a new chat group in Feishu.

Input Parameters

• Name: Name of the chat group to be created (required).

Options

• ChatType: Type of chat group (default: "p2p").
• MemberIdType: Type of ID for the members to add (default: "open_id").

Output

• Data (object): Response data containing created chat information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Delete Chat

Delete (dissolve) a chat group in Feishu.

Input Parameters

• ChatId: ID of the chat group to be deleted (required).

Output

• Data (object): Response data containing deletion confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Chat

Get chat information in Feishu.

Input Parameters

• ChatId: ID of the chat to retrieve information for (required).

Output

• Data (object): Response data containing chat information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Chat List

Get the list of chats that the user or bot is a member of in Feishu.

Input Parameters

• UserId: ID of the user to get chat list for (required).

Options

• MemberIdType: Type of ID for the user (default: "open_id").

Output

• Data (object): Response data containing chat list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Chat Members

Get the list of members in a Feishu chat group.

Input Parameters

• ChatId: ID of the chat group to get members for (required).

Options

• MemberIdType: Type of ID for the members (default: "open_id").

Output

• Data (object): Response data containing member list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Is in Chat

Check if a user or bot is in a Feishu chat group.

Input Parameters

• ChatId: ID of the chat group to check (required).
• UserId: ID of the user or bot to check (required).

Options

• MemberIdType: Type of ID for the user or bot (default: "open_id").

Output

• Data (object): Response data containing boolean indicating if the user or bot is in the chat.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Join Chat

Allow current user or bot to join a Feishu chat group.

Input Parameters

• ChatId: ID of the chat group to join (required).

Options

• MemberIdType: Type of ID for the user or bot (default: "open_id").

Output

• Data (object): Response data containing addition confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Search Chats

Search for chats visible to the user or bot in Feishu.

Input Parameters

• Query: Search query string for fuzzy matching chat names (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of chats to return per page (1-100, default: 20).

Output

• Data (object): Response data containing search results.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Update Chat

Update chat information in Feishu.

Input Parameters

• ChatId: ID of the chat to be updated (required).

Options

• Name: New name for the chat.
• ChatType: New type for the chat.

Output

• Data (object): Response data containing updated chat information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Create Department

Creates a new department in Feishu organization structure.

Input Parameters

• Name: Name of the department to be created (required).

Options

• ParentId: ID of the parent department.

Output

• Data (object): Response data containing created department information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Delete Department

Deletes a department from Feishu organization structure. Ensure the department has no members or child departments before deletion.

Input Parameters

• DepartmentId: ID of the department to be deleted (required).

Output

• Data (object): Response data containing deletion confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Find Users by Department

Retrieves the list of users directly under a specific department in Feishu.

Input Parameters

• DepartmentId: ID of the department to find users for (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of users to return per page (1-100, default: 20).

Output

• Data (object): Response data containing user list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Child Departments

Retrieves the child departments of a specified department in Feishu.

Input Parameters

• DepartmentId: ID of the department to get child departments for (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of child departments to return per page (1-100, default: 20).

Output

• Data (object): Response data containing child department list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Departments

Batch retrieves department information from Feishu by department IDs.

Input Parameters

• DepartmentIds: List of department IDs to retrieve (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of departments to return per page (1-100, default: 20).

Output

• Data (object): Response data containing department list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Parent Department

Retrieves the parent departments of a specified department in Feishu.

Input Parameters

• DepartmentId: ID of the department to get parent departments for (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of parent departments to return per page (1-100, default: 20).

Output

• Data (object): Response data containing parent department list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Search Departments

Searches for Feishu departments by name using the official search API, returning a list of departments that match the search query.

Input Parameters

• Query: Search query string for fuzzy matching department names (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of departments to return per page (1-100, default: 20).

Output

• Data (object): Response data containing search results.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Update Department

Updates department information in Feishu organization structure. Only non-empty fields will be updated.

Input Parameters

• DepartmentId: ID of the department to be updated (required).

Options

• Name: New name for the department.
• ParentId: New parent ID for the department.

Output

• Data (object): Response data containing updated department information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Create Markdown Document

Create a Feishu cloud document from Markdown content with complete workflow integration.

Input Parameters

• Title: Title of the document to be created (required).
• ParentId: ID of the parent folder for the document (required).

Options

• Body: Markdown content for the document (required).

Output

• Data (object): Response data containing created document information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Document Content

Retrieves the content of a Feishu cloud document in Markdown format.

Input Parameters

• DocumentId: ID of the document to retrieve content for (required).

Output

• Data (object): Response data containing document content.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Create Folder

Create a new folder in Feishu Drive.

Input Parameters

• Name: Name of the folder to be created (required).
• ParentId: ID of the parent folder for the new folder (required).

Output

• Data (object): Response data containing created folder information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

List Folder Files

List all files and folders in a specified Feishu Drive folder with pagination support.

Input Parameters

• FolderId: ID of the folder to list files for (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of files/folders to return per page (1-1000, default: 100).

Output

• Data (object): Response data containing file/folder list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Add Attendees to Event

Add one or more attendees to a specified event in a calendar.

Input Parameters

• CalendarId: ID of the calendar containing the event (required).
• EventId: ID of the event to add attendees to (required).
• Attendees: List of user IDs or bot IDs to add as attendees (required).

Options

• AttendeeIdType: Type of ID for the attendees (default: "open_id").

Output

• Data (object): Response data containing addition confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Create Event

Create a new calendar event in Feishu.

Input Parameters

• CalendarId: ID of the calendar to create the event in (required).
• Summary: Summary of the event (required).
• StartTime: Start time of the event (required).
• EndTime: End time of the event (required).

Options

• Description: Description of the event.
• Attendees: List of user IDs or bot IDs to add as attendees.
• AttendeeIdType: Type of ID for the attendees.

Output

• Data (object): Response data containing created event information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Delete Event

Delete a calendar event in Feishu.

Input Parameters

• CalendarId: ID of the calendar containing the event (required).
• EventId: ID of the event to delete (required).

Output

• Data (object): Response data containing deletion confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Event

Get details of a calendar event in Feishu.

Input Parameters

• CalendarId: ID of the calendar containing the event (required).
• EventId: ID of the event to retrieve (required).

Output

• Data (object): Response data containing event information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

List Events

List calendar events in Feishu.

Input Parameters

• CalendarId: ID of the calendar to list events for (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of events to return per page (1-100, default: 20).

Output

• Data (object): Response data containing event list information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Remove Attendees from Event

Remove one or more attendees from a calendar event in Feishu.

Input Parameters

• CalendarId: ID of the calendar containing the event (required).
• EventId: ID of the event to remove attendees from (required).
• Attendees: List of user IDs or bot IDs to remove as attendees (required).

Options

• AttendeeIdType: Type of ID for the attendees.

Output

• Data (object): Response data containing removal confirmation.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Search Events

Search for relevant events in a specified calendar, supporting keyword search and filtering.

Input Parameters

• CalendarId: ID of the calendar to search in (required).
• Query: Search query string for fuzzy matching event names (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of events to return per page (1-100, default: 20).

Output

• Data (object): Response data containing search results.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Update Event

Update a calendar event in Feishu.

Input Parameters

• CalendarId: ID of the calendar containing the event (required).
• EventId: ID of the event to update (required).

Options

• Summary: New summary for the event.
• StartTime: New start time for the event.
• EndTime: New end time for the event.
• Description: New description for the event.
• Attendees: New list of user IDs or bot IDs to add as attendees.
• AttendeeIdType: New type of ID for the attendees.

Output

• Data (object): Response data containing updated event information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Send Message

Sends a message to a specified user or group in Feishu.

Input Parameters

• ReceiveId: ID of the user or group to send the message to (required).
• ReceiveIdType: Type of ID for the recipient (default: "open_id").

Options

• Content: Message content (required).

Output

• Data (object): Response data containing message information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Send Urgent Notification

Sends an urgent in-app notification to specified users for a specific message in Feishu.

Input Parameters

• ReceiveId: ID of the user or group to send the notification to (required).
• ReceiveIdType: Type of ID for the recipient (default: "open_id").

Options

• Content: Message content (required).

Output

• Data (object): Response data containing notification information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Send Urgent Phone Call

Sends an urgent phone call notification to specified users for a specific message in Feishu.

Input Parameters

• ReceiveId: ID of the user or group to send the notification to (required).
• ReceiveIdType: Type of ID for the recipient (default: "open_id").

Options

• Content: Message content (required).

Output

• Data (object): Response data containing notification information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Send Urgent SMS

Sends an urgent SMS notification to specified users for a specific message in Feishu.

Input Parameters

• ReceiveId: ID of the user or group to send the notification to (required).
• ReceiveIdType: Type of ID for the recipient (default: "open_id").

Options

• Content: Message content (required).

Output

• Data (object): Response data containing notification information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get One User ID by Contact

Retrieves a single user ID from Feishu by email address or mobile phone number. Phone takes priority when both are provided.

Input Parameters

• Email: Email address of the user.
• Phone: Mobile phone number of the user.

Options

• UserIdType: Type of ID to return (default: "open_id").

Output

• Data (object): Response data containing user ID.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get User ID by Contact

Retrieves user IDs from Feishu by email addresses or mobile phone numbers.

Input Parameters

• Emails: List of email addresses of users.
• Phones: List of mobile phone numbers of users.

Options

• UserIdType: Type of ID to return (default: "open_id").

Output

• Data (object): Response data containing user IDs.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Get Users

Batch retrieves user information from Feishu by user IDs.

Input Parameters

• UserIds: List of user IDs to retrieve (required).

Options

• UserIdType: Type of ID for the users (default: "open_id").

Output

• Data (object): Response data containing user information.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

Search Users

Searches for Feishu users by name, email, or other user attributes, returning a list of users that match the search query.

Input Parameters

• Query: Search query string for fuzzy matching user names (required).

Options

• PageToken: Pagination token for retrieving the next page of results.
• PageSize: Maximum number of users to return per page (1-100, default: 20).

Output

• Data (object): Response data containing search results.
• StatusCode (number): Operation status code: 200 (success), -1 (parameter error), others for API errors.
• ErrorMessage (string): Error description if the operation fails, empty string on success.

5. Example Usage

This section will guide you through creating a simple workflow to send a welcome message to a new user in Feishu.

The workflow will look like this: Trigger: New User -> Feishu: Send Message -> Answer.

1. Add the Tool Node

• On the workflow canvas, click the + icon to add a new node.
• In the panel that appears, select the "Tools" tab.
• Find and select Feishu from the list of tools.
• In the list of supported operations for Feishu, click Send Message. This will add a "Send Message" node to your canvas.

2. Configure the Node

• Click on the newly added Send Message node to open its configuration panel on the right.
• Configure Credentials: At the top of the panel, find the credentials field. Click the dropdown menu and select the Feishu credentials you have already configured.
• Fill in Parameters:
  • ReceiveId: Map this field to the Open ID of the new user from your trigger step. For example, @{trigger.user.open_id}.
  • ReceiveIdType: Leave this as the default open_id, or select the appropriate ID type you are using.
  • Content: Type the welcome message you want to send. For example, "Welcome to the team!". You can also use variables, like Welcome, @{trigger.user.name}!.

3. Run and Validate

• Once all required parameters are filled in correctly, any error indicators on the workflow canvas will disappear.
• Click the "Test Run" button in the top-right corner of the canvas to execute the workflow.
• After a successful execution, the specified user will receive the message in their Feishu app. You can also click the log icon in the top-right corner to view the detailed input and output of the node for verification.

After completing these steps, your workflow is configured. Every time a new user is detected by the trigger, a welcome message will be automatically sent to them in Feishu.

6. FAQs

Q: I am getting an "invalid app_ticket" or "invalid access token" error. What should I do?

A: This usually indicates an issue with your Feishu app credentials or configuration.

• Check Credentials: Ensure your App ID and App Secret are correctly entered in the GoInsight credentials configuration.
• IP Whitelist: In your Feishu app settings, make sure the IP address of the GoInsight server is added to the IP whitelist if you have it enabled.
• App Permissions: Verify that your Feishu app has been granted the necessary API permissions for the operations you are trying to perform (e.g., im:message for sending messages, contact:user.readonly for reading user info).
• App is Published: Ensure your app has been published and is available for use within your organization.

Q: Why is my Send Message operation failing?

A: Common reasons for message sending failures include:

• Incorrect ReceiveId: Double-check that the user ID or chat ID you are providing is correct and matches the specified ReceiveIdType.
• Bot is not in the group: If you are sending a message to a group chat, the bot (your Feishu app) must be a member of that chat.
• Content Formatting: Ensure the Content parameter is correctly formatted. For simple text, just provide the string. For complex messages (like rich text or cards), it must be a valid JSON string as per Feishu's API documentation.

Q: How do I find the DepartmentId or a user's open_id?

A: You can use other Feishu nodes within your workflow to find these IDs dynamically.

• To find a DepartmentId, you can use the Search Departments or Get Child Departments operations.
• To find a user's open_id, you can use operations like Get User ID by Contact (if you have their email/phone) or Search Users.

7. Official Documentation

For more detailed information on Feishu's API capabilities and data structures, please refer to the Feishu Open Platform Documentation.