Welcome to the
WalkMe Help Center
Please log in to continue
Please log in to continue
デスクトップとモバイルのメニュー通知APIを使用すると、任意のシステム(WalkMeスニペットがない場合でも)でイベントを使用して、WalkMeで通知をトリガーし、ユーザーに自動的に最新情報を提供することができます。 WalkMe通知WebhookにRESTコールでメニュー通知をトリガーします。
この記事では、認証トークンとJSONペイロードの両方を必要とするRESTコールを実行するために必要な情報を提供します。
REST APIを呼び出すことができるシステムはどれでもデスクトップ/モバイルメニューで通知をトリガーするために使用できます。
APIを呼び出すには、いくつかの権限と技術的な設定が必要です。 アクセス権があり、以下の操作が可能であることを確認してください:
APIをトリガーするためにWalkMeに必要なものは以下の通りです。 すべてを収集する方法は以下の通りです。
具体的には、以下の情報を含む通知JSONを使用するために必要な情報があります:
アクセストークンとは何ですか?
アクセストークンは、アプリケーションがAPIにアクセスするために使用できる資格情報です。 彼らは、トークンのベアラが特定のアクションにアクセスすることが許可されたことをAPIに通知します。
アクセストークンがAPIコールを認証し、システムからメニューにデータを渡す権限をアプリケーションに付与します。
新しいキーの作成パネルから:
キーの詳細パネルから:
追加サポートと認証トークンを取得するために:開発者ページ
コミュニケーションセンターに移動し、カスタムテンプレートを作成します(通知の作成方法をご覧ください)。 API用に作成する通知には、以下の点に留意してください。
通知をユーザーまたはトリガーされたイベントに合わせてパーソナライズしたい場合、APIが自動的に入力する動的な値を追加できます。
画像では、APIトリガーによって置換される動的テキストで値が上書きされる2つの例を確認できると思います。

これは、新しいリードが割り当てられたときにトリガーされるSalesforceのAPI通知の例です。 セールスパーソンに機会名とSalesforceのリードへのリンクが通知されます。
以下のステップでは、通知をAPIに接続します。


追加サポート開発者ページのために
API接続アプリケーションに関する情報を入力します。 明確にするためにZapierを使用して説明しますが、このアプリケーションを他のアプリケーションよりも支持するものではありません。 同様のアプリが動作します。
以下で使用される情報は、すべてのアプリケーションで普遍的に必要となります。

基本的な認証を追加
基本認証を使用する場合、クライアントIDはユーザー名であり、クライアントシークレットがパスワードとして使用されます。
この情報を追加すると、アクセストークンが提供されます。

今度は空白を埋め、通知を呼び出すJSONコードを使用します。
|
{ 「通知」:{ "systemId": "<the workstation system id>", //複数のワークステーションシステムがある場合に必要です "templateId": "<template id>", //必須 "endUsersIds": ["<end user id 1>,"<end user id 2>","<...>"], //エンドユーザーIDまたはオーディエンスID(両方を使用できます)が必要であり、使用していないものを削除します。 "audiencesIds": ["<audience id 1>,"<audience id 2>","<...>"], //エンドユーザーIDまたはオーディエンスID(両方を使用できます)が必要であり、使用していないものを削除します。 "notificationType": "<how notification will display, push v popup>", //オプション、デフォルトのプッシュ、使用していない場合は削除します "title": "<notification title as appears in the ComCenter notification table>", //オプション、使用していない場合は削除します "runtimeTitle": "<what will appear to end-users in the Workstation list and in the push notification>", //オプション、使用していない場合は削除します "runtimeDescription": "<what will appear to end-users i in the Workstation list and in the push message>", //オプション、使用していない場合は削除します "startAt": "<start date YYYY-MM-DD hh:mm>", // オプション、デフォルトは今すぐです、タイムゾーンは UTC、日付を追加し、時間なしで追加できます、デフォルト時間は 00:00 UTC、使用していないものはすべて削除します。 "endAt": "<end date YYYY-MM-DD hh:mm>", // オプション、デフォルトは今から30日後です。日付は追加でき、時間は追加できません。デフォルト時間は00:00であり、使用していないものはすべて削除します。 「オーバーライド」:[ { // コンマ区切り{key:value}ペアが増える // 例えば、チケットを開くためにServiceNowから渡されるURLが値となります ] } } |
以下は、よりシンプルにするために実際のデータが削除されたJSONコードの例です。
| { 「通知」:{ 「systemId」:「bcf4c7f5682b4aa6875a0fc9bdfa21ca」 「テンプレートId」:「1e5afe51-2d2a-4b22-a60a-cf2d6c01d726」 「endUsersIds」:["name@email.com"]、 「runtimeTitle」:「APIテスト3」 「notificationType」:「プッシュ」 「オーバーライド」:[ {「キー」:「URL」 「値」:「www.someurl.com」} ] } } |
必要な情報が得られたので、その根拠を結びつけましょう。 通話を行う(システムを接続して組織のデスクトップ/モバイルメニューで新しい通知を作成および公開)には、JSON プラス以下が必要です:
