Feishu Node icon

Feishu Node

Feishu Node

Actions106

Overview

This node integrates with the "多维表格" (Bitable) service of Feishu, specifically enabling batch saving of table fields. It allows users to define or update multiple fields in a Feishu Bitable data table in one operation. This is useful for automating schema updates or synchronizing field definitions programmatically.

Common scenarios include:

  • Automating the creation or modification of multiple columns/fields in a Bitable table.
  • Managing complex table schemas where multiple fields need to be updated simultaneously.
  • Integrating with other systems that require dynamic field management in Feishu tables.

Example: A user wants to add several new fields such as "Customer Name", "Order Date", and "Status" to a Bitable table at once, specifying their types and additional properties.

Properties

Name Meaning
多维表格 Token The unique identifier token for the Feishu Bitable App. Required for authenticating API requests.
多维表格 ID The unique identifier of the Bitable data table where fields will be batch saved.
字段定义方式 Method to define fields. Options:
- Field: Define fields using structured input with name, type, and extended JSON properties.
- JSON: Provide raw JSON array defining fields directly.
字段列表 When "字段定义方式" is "Field", this collection allows defining multiple fields. Each field includes:
- 字段名称 (Field Name): Name of the field.
- 字段类型 (Field Type): Type of the field, options include text, number, single select, multi select, date, checkbox, person, phone number, hyperlink, attachment, single relation, formula, bidirectional relation, location, group, create time, last update time, creator, modifier, auto number.
- 字段扩展属性 (Field Extended Properties): Additional JSON properties merged automatically, following Feishu Bitable API specifications.
请求体JSON When "字段定义方式" is "JSON", provide the entire request body as a JSON array describing the fields according to Feishu Bitable API format.

Output

The node outputs an array of JSON objects representing the result of the batch save operation for each input item. Each output item corresponds to the processed input and contains the response from the Feishu Bitable API regarding the created or updated fields.

No binary data output is involved.

Dependencies

  • Requires an API authentication token ("多维表格 Token") for the Feishu Bitable App.
  • Needs the unique table ID ("多维表格 ID") to identify which table's fields are being modified.
  • Relies on Feishu Bitable API endpoints for batch saving fields.
  • The node requires proper credentials configured in n8n to authenticate requests to Feishu services.

Troubleshooting

  • Invalid Token or Table ID: If the token or table ID is incorrect or expired, the API call will fail. Verify the token and table ID values.
  • Malformed JSON: When using the JSON definition method, ensure the JSON structure matches the Feishu Bitable API specification exactly.
  • Unsupported Field Types or Properties: Using unsupported field types or invalid extended properties may cause errors. Refer to the official API documentation for valid values.
  • API Rate Limits or Network Issues: Temporary failures might occur due to rate limits or connectivity problems. Retrying after some time or checking network status can help.
  • Error Messages: Errors thrown by the node typically include messages from the Feishu API. Review these messages carefully to identify issues like permission denied, invalid parameters, or quota exceeded.

Links and References

Discussion