awork icon

awork

Automate your workflows with the awork API
Join our community

Actions36

Overview

This node operation creates a new document within a specified document space or project in the awork platform. It is useful for automating the creation of structured documents with HTML content, optionally nested under a parent document, and can include an emoji icon for easy identification. Practical applications include generating project documentation, meeting notes, or any structured content that needs to be programmatically added to awork.

Use Case Examples

  1. Create a project report document with HTML content and an emoji icon.
  2. Add a nested document under an existing parent document in a document space.
  3. Automate the creation of meeting notes documents in a specific project.

Properties

Name Meaning
Document Space ID The ID of the document space where the document will be created. Either this or Project ID must be provided.
Project ID The ID of the project where the document will be created. Either this or Document Space ID must be provided.
Document Name The name of the document to be created.
Document Content The HTML content of the document.
Emoji An emoji icon to visually represent the document.
Parent Document ID The ID of another document in the same project or document space to nest this document under.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • id - The unique identifier of the created document.
  • name - The name of the created document.
  • content - The HTML content of the created document.
  • emoji - The emoji icon associated with the document.
  • parentId - The ID of the parent document if the document is nested.
  • projectId - The ID of the project where the document was created.
  • documentSpaceId - The ID of the document space where the document was created.
  • createdAt - Timestamp when the document was created.
  • updatedAt - Timestamp when the document was last updated.

Dependencies

  • awork API key credential

Troubleshooting

  • Ensure either Document Space ID or Project ID is provided; missing both will cause errors.
  • Verify that the Document Name is provided as it is required.
  • Check network connectivity and proxy settings if requests fail.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security risks.
  • Timeout errors can be resolved by increasing the timeout setting in request options.

Links

  • awork API Documentation - Official API documentation for awork, useful for understanding document creation endpoints and parameters.

Discussion