Notifications API - Introduction

Description

A new Notifications API has been introduced to manage notification preferences in SmartRecruiters. This API allows you to configure how and when notifications are delivered to employees and set global notification preferences for your organization.

The API provides the following capabilities:

  • Employee Preferences Management: Get, save, and update individual employee notification preferences for specific channels (EMAIL, SLACK, TEAMS). You can manage preferences for different hiring team roles and notification types.
  • Global Preferences Management: Configure organization-wide notification preferences that apply to all users. You can choose to save preferences while preserving individual user settings, or override all individual preferences.
  • Notification Types Discovery: Retrieve all supported notification types along with the applicable hiring team roles and delivery channels for each type.
  • Bulk Operations: Activate or deactivate multiple notification preferences in a single request for both employee and global preferences.

The API supports OAuth2 authentication with the following scopes:

  • notification_preferences:read - Read access to notification preferences
  • notification_preferences:manage - Write access to notification preferences

Impact

This is a new API addition and does not affect any existing APIs or integrations.

References