Please log in to continue
WalkMe stores your data in the region chosen during account setup.
We have data centers in the US and EU that follow local privacy and compliance laws. If you're not sure which region to select, check with your admin.
デスクトップとモバイルメニュー通知APIでは、任意のシステム（WalkMeスニペットがない場合でも）のイベントを使用して、WalkMeで通知をトリガーし、自動的にユーザーを最新状態に保つことができます。 WalkMe通知WebhookにRESTコールでメニュー通知をトリガーします。
この記事では、認証トークンとJSONペイロードの両方を必要とするRESTコールを実行するために必要な情報を提供します。
REST APIを呼び出すことができるシステムはどれでもデスクトップ/モバイルメニューで通知をトリガーするために使用できます。
APIを呼び出すには、いくつかの権限と技術的な設定が必要です。 アクセス権があり、以下の操作が可能であることを確認してください：
APIをトリガーするためにWalkMeに必要なものは以下の通りです。 すべてを収集する方法は以下の通りです。
具体的には、以下の情報を含む通知JSONを使用するために必要な情報があります：
アクセストークンとは何ですか？
アクセストークンは、アプリケーションがAPIにアクセスするために使用できる資格情報です。 彼らは、トークンのベアラが特定のアクションにアクセスすることが許可されたことをAPIに通知します。
アクセストークンがAPIコールを認証し、システムからメニューにデータを渡す権限をアプリケーションに付与します。
コンソールに移動します
管理センターカテゴリを選択します
「アクセス管理」を選択します
APIキーページを選択します
[新しいキーの作成]をクリックします
新しいキーの作成パネルから：
キーの詳細パネルから：
追加サポートと認証トークンを取得するために：開発者ページ
コミュニケーションセンターに移動し、カスタムテンプレートを作成します（通知の作成方法をご覧ください）。 API用に作成する通知には、以下の点に留意してください。
通知をユーザーまたはトリガーされたイベントに合わせてパーソナライズしたい場合、APIが自動的に入力する動的な値を追加できます。
画像では、APIトリガーによって置換される動的テキストで値が上書きされる2つの例を確認できると思います。
これは、新しいリードが割り当てられたときにトリガーされるSalesforceのAPI通知の例です。 セールスパーソンに機会名とSalesforceのリードへのリンクが通知されます。
以下のステップでは、通知をAPIに接続します。
For extra support Developer page.
Now it's time to fill in some information on your API connection application. For clarity, we use Zapier to explain, but we are not endorsing this application over any other. Any similar app will work.
The information used below is universally necessary on all applications:
Add Basic Authentication
When using basic Auth, the clientID is the username and the client secret is used as the password.
Once you've added this information, you will be given an access token.
Now it's time to fill in the blanks and use the JSON code that will call the notification.
|
{ "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 if not using "title": "<notification title as appears in the ComCenter notification table>", //Optional, remove if not using "runtimeTitle": "<what will appear to end-users in the Workstation list and in the push notification>", //Optional, remove if not using "runtimeDescription": "<what will appear to end-users i in the Workstation list and in the push message>", //Optional, remove if not using "startAt": "<start date YYYY-MM-DD hh:mm>", // Optional, default right now, timezone is UTC, you can add a date and no time, default time is 00:00 UTC, 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": [ { // More comma separated {key:value} pairs can follow // For example, the value could be a URL that is passed from ServiceNow to open a ticket ] } } |
Here is an example of the JSON code with real data with few lines removed to make it simpler.
| { "notification": { "systemId": "bcf4c7f5682b4aa6875a0fc9bdfa21ca", "templateId": "1e5afe51-2d2a-4b22-a60a-cf2d6c01d726", "endUsersIds": ["name@email.com"], "runtimeTitle": "API Test 3", "notificationType": "Push", “override”: [ {“key”: “URL”, “value”: “www.someurl.com”} ] } } |
Now that we have the information we need, let's connect the dots. To make the call (connect the systems to create and publish new notifications in your organization's desktop/mobile menu), you'll need your JSON plus:
A single call supports up to 50,000 recipients