awork icon

awork

Automate your workflows with the awork API

Overview

This node interacts with the awork API to retrieve all statuses associated with projects. It is useful for automating workflows that require monitoring, reporting, or acting upon the status of various projects within awork. For example, you might use this node to:

  • Generate a dashboard showing the current status distribution of all projects.
  • Trigger notifications or actions when projects reach certain statuses.
  • Integrate project status data into other systems for further processing.

Properties

Display Name Type Description
Return All Boolean Whether to return all results or only up to a given limit.
Filter By String Filter the results by specific criteria. See awork filtering documentation for details. Example: duration gt 5
Order By String Order the results by a specific field and direction. See awork ordering documentation for details. Example: FirstName asc

Output

The output will be a JSON array where each item represents a project status as returned by the awork API. The structure of each item typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "color": "string",
  "isDefault": true,
  "isClosed": false,
  // ...other fields as provided by the awork API
}

Note: The exact fields depend on the awork API's response for project statuses.

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 Credentials: If your API key is missing or incorrect, the node will fail to authenticate. Ensure your awork API credentials are correctly set up in n8n.
  • Filtering/Ordering Errors: Incorrect syntax in the "Filter By" or "Order By" fields may result in errors from the awork API. Refer to the filtering and ordering documentation for correct usage.
  • Insufficient Permissions: The API key used must have permission to read project statuses; otherwise, requests may be denied.

Error Messages:

  • 401 Unauthorized: Check your API credentials.
  • 400 Bad Request: Review your filter or order expressions for typos or unsupported fields.
  • 404 Not Found: The resource or endpoint may not exist, or your account may lack access.

Links and References

Discussion