MacOS
View all Worklets
MacOSmacOS

macOS - Tray Notification - Customize Branding Icon

Set custom branding icons for the Automox Agent tray on macOS endpoints

Worklet Details

What the Automox Agent tray icon customizer does

This Automox Worklet™ sets custom branding icons for the Automox Agent tray interface on macOS endpoints. The Worklet accepts PNG image files (256 by 256 pixels) for both dark mode and light mode display contexts, then applies these icons using the amagent notifications set_icon command.

The Worklet validates that Automox Agent version 2.5 or higher is installed before applying the branding icons. This ensures the notification icon API is available and compatible with your endpoint configuration.

Why customize the Automox Agent tray icon

Customizing the agent tray icon allows your organization to establish visual consistency across endpoints. When IT operations teams see a branded icon that matches your company's design language, it reinforces trust in the Automox solution and creates a more professional user experience.

Supporting both light and dark mode icons ensures the agent tray remains visually clear and accessible regardless of the endpoint's system appearance settings. This eliminates icon visibility issues that could occur with a single-color design.

How Automox Agent icon customization works

  1. Evaluation phase: The Worklet checks whether the Automox Tray application is installed at /Library/Application Support/Automox/agent-ui and verifies the amagent executable exists at /usr/local/bin/amagent. It then retrieves the installed agent version and confirms it meets the minimum requirement of 2.5.0.

  2. Remediation phase: The Worklet validates that both icon files are PNG format, then executes the amagent notifications set_icon command with the dark mode and light mode icon paths. The agent service receives the new icon configuration and applies it to the tray interface immediately.

Automox Agent icon customization requirements

  • Automox Agent version 2.5.0 or higher installed on the endpoint

  • macOS operating system (10.14 or later recommended)

  • Custom branding icons in PNG format, sized at 256 by 256 pixels

  • Icon files uploaded as Worklet payloads (darkModeIcon.png and lightModeIcon.png)

  • Administrative or root-level execution permissions on the endpoint

Expected Automox Agent tray appearance after customization

After the Worklet completes successfully, the Automox Agent tray icon in the macOS menu bar will display your custom branding icon. The icon automatically switches between the dark mode and light mode variants based on the endpoint's current system appearance setting, verifying optimal visibility in both contexts. You can verify this change through the Automox Activity Log or by checking the endpoint configuration directly.

Verify success by checking the menu bar and confirming that the icon matches your custom branding design. If you change the system appearance setting, the tray icon should reflect the corresponding dark or light mode icon immediately.

How to validate customize branding icon changes

  1. Run this Worklet on a pilot macOS endpoint and review evaluation output for customize branding icon.

  2. Confirm Automox activity logs show successful completion and exit code 0.

  3. Verify endpoint state using checks aligned to evaluation script logic, such as function, /usr/local/bin/amagent, break.

  4. Validate remediation effects from script operations such as function, /usr/local/bin/amagent, break, then rerun evaluation for compliance.

For technical validation, compare endpoint state to the Worklet evaluation logic and remediation flow for customize branding icon. This supports repeatable tray management workflows, faster change control review, and auditable compliance evidence.

Useful script references for this Worklet include evaluation operations such as function, /usr/local/bin/amagent, break and remediation operations such as function, /usr/local/bin/amagent, break. Use these indicators to verify that endpoint changes match intended policy outcomes.

View in app
evalutation image
remediation image

Consider Worklets your easy button

What's a Worklet?

A Worklet is an automation script, written in Bash or PowerShell, designed for seamless execution on endpoints – at scale – within the Automox platform. Worklet automation scripts perform configuration, remediation, and the installation or removal of applications and settings across Windows, macOS, and Linux.

do more with worklets