Envoy(受付アプリ)のSlack通知が遅いので自作

概要
設計
1. 設定
通知のサンプル
まとめ
参考資料

概要

Envoyというオフィスのエントランスで受付をするシステムがあります。
理想のワークフローは、Envoyで訪問者が受付をした際に、担当者宛にSlackで通知を飛ばすこと。
Envoyが提供しているSlackのIntegrationを使うと、通知が届くまで4〜5分かかるのでかなり問題。（どうやら、2回めの通知は早い。SlackのIntegrationの初回呼び出しが遅い感じ。）
Envoyからのwebhookは即時で届くので、SlackのIntegrationを使うのではなく自作したプログラムを使います。

設計

通信のフローは以下のようになります。

Envoy => (webhook) => なんかしらのScript => (webhook) => Slack

Scriptの部分を作って設置します。

スクリプトは以下のような感じです。EnvoyからはPOSTでいろいろなデータが送られてくるので、必要なデータを抽出してSlackへ通知します。

SlackのWebhookのURLはパラメータで受け取れるようにしておきます。

<?php

if ($_SERVER['REQUEST_METHOD'] != 'POST') {

 print 'This script should be requested by POST method.';

 exit;

}

$LOG_FILE = dirname(__FILE__).'/hook.txt';

$body = file_get_contents('php://input');

if (!$body) { throw new Exception('input is not found'); }

$payload = json_decode($body, true);

# log

file_put_contents($LOG_FILE, date("[Y-m-d H:i:s]")." ".print_r($payload,1)."\n", FILE_APPEND|LOCK_EX);

$url = $_GET['slack_webhook_url'];

$rows = array();

 foreach ($payload['payload']['attributes']['user-data'] as $array) {

 $rows[] = (array('title' => $array['field'], 'value' => $array['value']));

}

$rows[] = (array('title' => '訪問時間', 'value' => $payload['payload']['attributes']['signed-in-at']));

$message = [

 'username' => 'neo-envoy',

 'text' => sprintf('%s 様が%s %s の受付でお待ちです。',

 $payload['payload']['attributes']['full-name'],

 $payload['meta']['company']['attributes']['name'],

 $payload['meta']['location']['attributes']['name']

 ),

 'attachments' => [

 [

 'text' => $payload['payload']['attributes']['full-name'],

 'color' => 'good',

 'fields' => $rows

 ],

 ]

];

if ($payload['payload']['attributes']['host']) {

 $message['attachments'][] =

 [

 'text' => '訪問先',

 'color' => 'warning',

 'fields' => [

 [

 'title' => $payload['payload']['attributes']['host'],

 'value' => $payload['payload']['attributes']['host-email'],

 ],

 ]

 ];

}

$ch = curl_init();

$options = [

 CURLOPT_URL => $url,

 CURLOPT_RETURNTRANSFER => true,

 CURLOPT_SSL_VERIFYPEER => false,

 CURLOPT_POST => true,

 CURLOPT_POSTFIELDS => http_build_query([

 'payload' => json_encode($message)

 ])

];

curl_setopt_array($ch, $options);

curl_exec($ch);

curl_close($ch);

view raw

slack.php

hosted with ❤ by GitHub

設定

予め、Slack側で通知を送りたいチャネルでwebhookのURLを発行しておきます。

Envoyに管理者でログインして、上記のスクリプトのURLを登録します。

Envoy

設定するWebhookのURLには忘れずにurlパラメータでslackの通知先webhookを入力します。一応、urlencodeした値を入れておきます。

URL例

https://example.com/slack.php?url=https%3A%2F%2Fhooks.slack.com%2Fservices%2FT0000XXXX%2Fxxxxxxxxxxx%2Fxxxxxxxxxxxxxxxxxxxxxxxxx

通知のサンプル

まとめ

ほぼ即時に通知が来るようになりました。
webhookを動かしているPHPのアプリケーションサーバが落ちると通知が来なくて辛い状態になります。
mentionさせるためには、SlackとEnvoy間でユーザの紐付けをしないといけないので今回はやってません。

参考資料

EnvoyからWebhookで送られてくるサンプルデータはこちらです。

Envoy(受付アプリ)のSlack通知が遅いので自作

概要

設計

設定

通知のサンプル

まとめ

参考資料

カテゴリ別人気記事

コメント