Trigger Workstation notifications with a REST call to our WalkMe Notification Webhook. With the Workstation Notifications API, you can use events in any system (even if it doesn’t have a WalkMe snippet) to trigger a notification in WalkMe and automatically keep your users up-to-date.

For more information on how to set up the Workstation Notification API and where to find the template ID - see https://support.walkme.com/knowledge-base/workstation-notifications-api/

JSON Code

{
    "notification": {
        "systemId": "<the workstation system id>", //Required if you have more than one workstation system
        "templateId": "<template id>", //required
        "endUsersIds": ["<end user id 1>","<end user id 2>","<...>"], //You need either end-user ID or audience ID (you can use both), remove the one you aren't using
        "audiencesIds": ["<audience id 1>","<audience id 2>","<...>"],  //You need either end-user ID or audience ID (you can use both), remove the one you aren't using
   "notificationType": "<how notification will display, push v popup>", //optional, default push, remove it not using
        "title": "<notification title>", //Optional, remove if not using
        "description": "<notification description>", //Optional, remove if not using
        "startAt": "<start date YYYY-MM-DD hh:mm>", // Optional, default right now, you can add a date and no time, default time is 00:00, remove whatever you are not using
        "endAt": "<end date YYYY-MM-DD hh:mm>", // Optional, default 30 days from now,  you can add a date and no time, default time is 00:00, remove whatever you are not using    
     "override": [
            {
                "key" : "<the placeholder string to replace in the notification template>",
                "value" : "<the value to put into the notification instead of the placeholder>"
            }
        // More comma separated {key:value} pairs can follow
        // for example, the a value could be a URL that is passed from ServiceNow to open a ticket
        ]  
    }
 }

Making the call

Method: POST

URL: https://api.walkme.com/public/v1/notifications/send