Get startedView Markdown ↗

App Icon Badge Count

Set any number you care about on your ActivitySmith app icon through the ActivitySmith API. Track MRR, user count, stock price, or any other value you want to keep in view.

How It Works#

Send a badge value through the API, an SDK, or the CLI.
Send 0 to clear the badge.
Use channels to target specific team members or devices.

Set the Badge Value#

await activitysmith.badgeCount(8333);

Clear the Badge#

Set the value to 0 to hide the badge

await activitysmith.badgeCount(0);

Target Specific Devices#

Use target.channels in API requests to target specific team members or devices

curl -X POST "https://activitysmith.com/api/badge" \
  -H "Authorization: Bearer $YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "badge": 3,
    "target": {
      "channels": ["sales", "customer-success"]
    }
  }'