awork icon

awork

Automate your workflows with the awork API

Overview

This n8n node interacts with the awork API to retrieve the task statuses associated with a specific project. It is particularly useful for workflow automation scenarios where you need to monitor, report on, or trigger actions based on the status of tasks within a project in awork.

Common use cases:

  • Fetching all possible task statuses for a given project to display them in dashboards.
  • Automating processes that depend on the current state of project tasks (e.g., sending notifications when tasks reach certain statuses).
  • Integrating awork project management data with other tools or services.

Practical example:
You might use this node in a workflow that checks the statuses of all tasks in a project every morning and sends a summary email to the project manager.

Properties

Display Name Type Meaning
Project ID String The unique identifier of the project whose task statuses you want to retrieve. Required.
Return All Boolean Whether to return all results or only up to a specified limit.
Filter By String Criteria to filter the results (e.g., duration gt 5). See awork filtering docs.
Order By String Field and direction to order the results (e.g., FirstName asc). See awork ordering docs.

Output

The node outputs a list of objects in the json field, each representing a task status for the specified project. Each object typically contains information such as:

{
  "id": "string",           // Unique identifier of the task status
  "name": "string",         // Name of the status (e.g., "In Progress")
  "color": "string",        // Color code associated with the status
  "isDefault": true,        // Indicates if this is the default status
  "order": 1                // Position/order of the status in the list
  // ...other fields as provided by the awork API
}

Note: The exact structure may vary depending on the awork API response.

Dependencies

  • External Service: Requires access to the awork API.
  • API Key: You must configure valid awork API credentials in n8n under the name aworkApi.
  • n8n Configuration: No additional configuration required beyond setting up credentials.

Troubleshooting

Common issues:

  • Invalid Project ID: If the provided Project ID does not exist or is incorrect, the node will fail to retrieve task statuses.
  • Missing Credentials: If awork API credentials are not set up or are invalid, authentication errors will occur.
  • API Rate Limits: Excessive requests may result in rate limiting by awork.

Typical error messages:

  • "Project not found": Check that the Project ID is correct and exists in your awork account.
  • "401 Unauthorized": Ensure your awork API credentials are correctly configured in n8n.
  • "400 Bad Request": Review your filter or order parameters for syntax errors.

Links and References

Discussion