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 allowing operations related to document subscriptions. The "Get Subscription Status" operation retrieves the current status of a subscription for a specific document or file within Lark Docs.
This node is useful in scenarios where you need to programmatically check if a user or system is subscribed to updates or changes on a particular document. For example, automation workflows can use this to verify subscription states before sending notifications or triggering further actions based on subscription status.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "Tenant Token" (an API key credential) or "OAuth2". |
| File Token | A required string token identifying the specific file/document in Lark Docs. |
| Subscription Id | A required numeric ID representing the subscription to query. |
| Options | Additional optional settings: |
| - Use Custom Body | Boolean flag indicating whether to send a custom request body instead of the default one. |
Output
The node outputs JSON data containing the subscription status details for the specified subscription ID and file token. This typically includes information such as subscription state, timestamps, subscriber details, and any metadata returned by the Lark Docs API.
No binary data output is indicated for this operation.
Dependencies
- Requires an active connection to Lark Suite's Open APIs.
- Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper permissions/scopes must be granted to the credentials to access subscription information.
Troubleshooting
- Invalid Credentials: If authentication fails, ensure that the provided Tenant Token or OAuth2 credentials are valid and have the necessary scopes.
- Missing Required Fields: The "File Token" and "Subscription Id" fields are mandatory. Omitting them will cause errors.
- Subscription Not Found: If the subscription ID does not exist or does not belong to the given file token, the API may return a not found error.
- API Rate Limits: Excessive requests might trigger rate limiting; handle retries accordingly.
- Use Custom Body Option: Enabling this without providing a proper custom body may lead to malformed requests.
Links and References
- Lark Suite Open API Documentation
- Lark Docs Subscription API Reference (for detailed subscription status fields and usage)