List Alert Templates
Changed onReturns the catalog of alert templates that company alert configurations are built from. These are the built-in alert types BambooHR supports (for example New Hire, Birthdays, Time Off Approved), each paired with the settings group it is filed under.
The response is an object with a single alerts array, ordered by groupName and then name. The alert-configuration endpoints represent the same identifier as bambooAlertId. The catalog is global: it lists every alert BambooHR offers and is not narrowed to the features the authenticated company has enabled, so a template appearing here does not guarantee that the company can configure it.
Use this to discover the bambooAlertId required by Create Alert Configuration (create-alert-configuration). For the alerts a company has already configured, use List Alert Configurations (list-alert-configurations) instead. Callers without view access to the company's Email Alerts settings receive 403 rather than a filtered result.
OAuth Scopes: alerts
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesalerts
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Object containing the alert template catalog.
Changes
- info
api operation id
0f0dcb585e5883175b6557c16cf6755aremoved and replaced withlist-alert-templates - info
api tag
Alertsadded - info
api tag
Alertremoved - info
added the media type
application/jsonfor the response with the status - info
added the media type
application/jsonfor the response with the status - info
added the non-success response with the status
- info