Feishu Node icon

Feishu Node

Feishu Node

Actions61

Overview

This node enables sending messages via the Feishu (Lark) platform. It supports various message types (text, image, file, etc.) and allows targeting users or groups using different identifier types (Open ID, Union ID, User ID, Email, Chat ID). This is useful for automating notifications, alerts, or information sharing within Feishu from n8n workflows.

Common scenarios:

  • Sending automated alerts to a user or group chat.
  • Notifying users about workflow events or approvals.
  • Sharing files, images, or rich content programmatically.

Example:
Automatically send a text or image message to a specific user when a new record is created in your CRM.

Properties

Name Type Meaning
用户ID类型 options The type of recipient identifier. Options include Open ID, Union ID, User ID, Email, or Chat ID. Determines how the recipient is specified.
消息接收者的 ID string The actual ID of the message recipient, matching the selected 用户ID类型.
消息类型 options The type of message to send (e.g., 文本 (text), 富文本 (post), 图片 (image), 文件 (file), etc.). See Feishu documentation.
消息内容 json The content of the message, as a JSON-formatted string. The structure depends on the selected 消息类型.
UUID string An optional unique string to deduplicate message requests.

Output

The node outputs an array of objects with a json field containing the response from the Feishu API. If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message (and possibly additional error details).

Example success output:

[
  {
    "json": {
      // Feishu API response fields, e.g.:
      "code": 0,
      "msg": "ok",
      "data": {
        "message_id": "om_xxx",
        ...
      }
    }
  }
]

Example error output (when Continue On Fail is enabled):

[
  {
    "json": {
      "error": "Error message here"
    },
    "pairedItem": 0
  }
]

If binary data is returned (e.g., for file uploads), it will be included in the output's binary property, but this node primarily returns JSON responses.

Dependencies

  • External Service: Requires access to the Feishu (Lark) Open Platform API.
  • Credentials: Needs n8n credentials named feishuCredentialsApi configured with appropriate API keys or tokens.
  • Environment: No special environment variables are required beyond n8n credential setup.

Troubleshooting

Common issues:

  • Invalid Credentials: If the Feishu API credentials are incorrect or missing, authentication errors will occur.
  • Incorrect Recipient ID: Using the wrong 用户ID类型 or an invalid 消息接收者的 ID will result in delivery failures.
  • Malformed 消息内容: If the JSON structure does not match the expected format for the selected 消息类型, the API may reject the request.
  • Duplicate UUID: Reusing the same UUID may cause the message to be ignored due to deduplication.

Error messages:

  • "未实现方法: message.message:send": Indicates that the selected resource/operation is not implemented.
  • "NodeApiError": Returned when the Feishu API responds with an error; check the error details for more information.
  • "Error message here": General error; review the input parameters and API documentation.

Resolution steps:

  • Double-check all input fields, especially 消息内容 formatting.
  • Ensure the correct 用户ID类型 and corresponding 消息接收者的 ID.
  • Verify that your Feishu credentials are valid and have the necessary permissions.

Links and References

Discussion