Actions28
- File Actions
- Multipart Upload File Actions
- Permission Member Actions
- Permissionpublic Actions
- Statistic Actions
- Media Actions
- Multipart Upload Media Actions
- Comment Actions
- Subscription Actions
- Document Import Actions
Overview
The node "Lark Files" provides integration with Lark's file management system, specifically enabling operations related to document files and subscriptions. The Create Subscription operation under the Subscription resource allows users to create a subscription for file events or changes in Lark Docs. This is useful for scenarios where you want to receive notifications or trigger workflows when specific files are updated or accessed.
Practical examples include:
- Automatically triggering a workflow when a shared document is modified.
- Monitoring file access or changes for compliance or audit purposes.
- Integrating Lark Docs file events into other systems like Slack or email alerts.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
| File Token | The unique token identifying the file to subscribe to (required). |
| Subscription Type | The type of subscription to create (string). |
| File Type | The type of the file involved in the subscription (string). |
| Use Custom Body | Boolean flag indicating whether to send a custom JSON body instead of standard parameters. |
| Custom Body | A JSON object representing a fully custom request body to send if "Use Custom Body" is true. |
Output
The node outputs JSON data representing the response from the Lark API after creating the subscription. This typically includes details about the newly created subscription such as its ID, status, and any metadata returned by the API.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authentication, either via a Tenant Token or OAuth2.
- Connects to the Lark Suite Open APIs at
https://open.larksuite.com/open-apis. - Proper configuration of credentials in n8n is necessary to authenticate requests.
Troubleshooting
- Invalid or missing file token: Ensure the "File Token" property is correctly set and corresponds to an existing file in Lark Docs.
- Authentication errors: Verify that the selected authentication method is properly configured and the token has sufficient permissions.
- API errors due to incorrect subscription or file types: Confirm that the values for "Subscription Type" and "File Type" match expected values supported by the Lark API.
- Custom Body usage: If using a custom body, ensure the JSON is valid and matches the API schema; otherwise, the request may fail.
Links and References
- Lark Open Platform Documentation
- Lark Docs API Reference (for file management and subscriptions)