Actions17
- Announcement Actions
- Employee Actions
- Holiday Actions
- Leave Request Actions
- Planning Actions
Overview
The node interacts with the Pulse API to manage various office-related resources, including announcements. Specifically, for the "Announcement" resource and the "Get Announcement List" operation, it retrieves a list of announcements from the Pulse system. This is useful in scenarios where you want to automate fetching current announcements for display, reporting, or further processing within an n8n workflow.
Practical examples include:
- Automatically retrieving the latest company announcements to send via email or chat.
- Aggregating announcements data for analytics or dashboard visualization.
- Filtering announcements based on criteria such as date, organization, or other custom fields.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Optional extra parameters to customize the request: |
| - Sort | The sort order to apply to the announcement list (e.g., ascending or descending by date). |
| - Page Number | The page number for paginated results (default is 1). |
| - Page Size | The number of announcements per page (default is 10). |
| - Filters | One or more filters to narrow down the announcements returned. Each filter consists of: |
| • Filter Key: the field to filter by (e.g., organization_id). | |
| • Values: comma-separated values to match for the filter key. | |
| - Fields | Specific fields to include in the response. Each field entry includes: |
| • Field Key: the category or path of fields (e.g., iam/organizations/people_directories). | |
| • Fields: comma-separated list of field names to retrieve (e.g., id,name). |
Output
The node outputs JSON data containing the list of announcements retrieved from the Pulse API. The structure typically includes metadata about the announcements such as IDs, titles, descriptions, dates, and any other fields requested via the "Fields" property.
If pagination is used, the output may also include information about total pages or items depending on the API response.
No binary data output is associated with this operation.
Dependencies
- Requires connection to the Pulse API via an API key credential configured in n8n.
- The node depends on the Pulse API helper utilities bundled with the node implementation to handle authentication and requests.
- Proper network access to the Pulse API endpoint is necessary.
Troubleshooting
- Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Invalid filter keys or field names may result in empty responses or errors.
- Pagination parameters out of range might return no data.
- Error messages:
"Unknown operation: "getAnnouncementList" is not supported for resource "announcement"!"indicates a misconfiguration of the operation name.- Network or API errors will be surfaced as error messages; ensure the API endpoint is reachable and credentials are valid.
- To resolve errors, verify that all input properties are correctly set, especially filters and fields, and confirm API credentials are properly configured.
Links and References
- Pulse API Documentation (replace with actual URL if available)
- n8n documentation on creating custom nodes