We have made some updated to the 'Task Events Webhooks' documentation to better reflect the payload structure, and added best practices for utilizing these events effectively.

What's new

• Updated payload information: The payload sample for a task status update now includes more updated information that better reflects the actual payload being returned.
• Best practices: We've added a best practices comment, emphasizing the importance of using these events primarily as notifications. Given that some fields in the payload, such as task descriptions or titles, may contain truncated values if they exceed a certain length, it is crucial to follow these guidelines to ensure accurate data handling.

To learn more, see Employee Task Events.

We have made some updated to the 'Read the public profile section of all active employees' endpoint. This endpoint returns a predefined list of fields for all active employees that the service user can access.

What's new

• The endpoint's description now includes references to articles about permissions and how to read employee data.
• The response schema has been updated to accurately reflect the fields being returned by this endpoint.

To learn more, see Read the public profile section of all active employees.

To support users in the transition from API Access Tokens to Service Users, we have published a new article: Transition from API Access Tokens. This guide is designed to help you determine if you are using any API Access Tokens and provide step-by-step instructions for a smooth transition.

Get a comprehensive overview of event details with the enhanced events log table in the Webhooks page.

Users can now view an enhanced event logs grid, featuring up to three months of logs (previously limited to 100 rows). They can filter events by status code, date, and event type, and also export the events to a file.

To learn more, see Getting started with webhooks.

The Submit a new time off request endpoint now allows you to send any type of request, including time off requests with different hours per day.

The Time off request endpoint now allows you to choose an example according to the request type on the endpoint page, and view the parameters required for each request type. To ensure smooth testing on the endpoint’s page, make sure you select the schema and example for the same type of time off request.

To learn more, see Time off request endpoint.

🚧

Deprecation note: The existing 'Submit a new time off request of different hours per day' endpoint has been deprecated. The different hours per day request is now supported in the main endpoint.

We’re excited to publish a new article: "How to Read Employee Data."

This guide is designed to help you make the most of Bob's API by covering:

1. The steps to read employee fields via the API.
2. Understanding the link between fields categories and permissions.
3. How to fetch fields metadata and convert list items to a human-readable format.
4. How to read employee tables and custom tables.

Whether you're already deep into your development process or just getting started, we hope this guide becomes a valuable resource for you.

Note: This new guide will replace the "How to work with lists Public API" article.

The documentation for the /search endpoints that return employee data were enhanced to better describe the fields being returned and how to process the response.

Relevant Endpoints:

• Search for Employees
• Read Company Employee Fields by Employee ID

What’s new?

• Enhanced documentation for request parameters and response formats.
• Added examples for the employee response schema with two types of data:
  • Human-readable format (humanReadable="REPLACE")
  • Machine format (humanReadable="")
• Improved explanation of request parameters.
• Added a default value for the showInactive parameter, allowing the endpoint to be called without using “Request example”.

The category for the Read Company Positions endpoint has been updated. Previously categorized under "Objects," it is now found under "Workforce Planning."

This change is part of our initiative to group endpoints by modules, providing clearer organization and easier navigation for users. This new categorization enhances clarity when searching for specific endpoints.

What's new?

1. The Read company reports endpoint now shows all the fields being returned by this endpoint in the response schema.
2. Required permissions now appear in the reports category main page.

Explore the Read company reports endpoint.

Maximum file size for some endpoints was increased from 1MB to 5MB.

Now all Documents endpoints support uploads for files up to 5MB.