API / 開発のTIPs
Webhook の受け口は、HTTPS で受け、3秒以内に 200番台の番号を返してください。返せないと RemoteLOCK は送り直し、6回送り直しても受け取れないときは、その Webhook を無効にしてメールでお知らせします。
対象:RemoteLOCK API やお知らせ機能の Webhook を受けるサーバーを作る方
受け口は HTTPS にしてください
Webhook を受ける URL は、HTTPS で受けられるようにしてください。
届いた通知が RemoteLOCK からのものか確かめてください
Webhook の通知先を登録するときに決めた秘密の値(シークレット)が、通知のヘッダー(
X-Secret)に入って届きます。受け口では、この値が登録した値と同じかを確かめ、違うものは捨ててください。3秒以内に 200番台を返してください
- 通知を受けたら、3秒以内に 200番台の番号(200 OK、202 Accepted など)を返してください
- 3秒を超えたり、200番台以外を返したりすると、失敗とみなされ、あとで送り直されます
- データベースへの書き込みなど時間のかかる処理は、応答を返したあとに行ってください(いったん受け取ってから、別の処理に回す作りにします)
- 通知は、必要なイベントだけを選んで設定してください
失敗が続いたときの流れを知っておいてください
- 失敗した通知は、時間をおいて送り直されます
- 失敗が3回続くと、RemoteLOCK のアカウントのメールアドレスに、無効にする前の警告のメールが届きます(Webhookの失敗を知らせるメール)
- 6回送り直しても成功しないと、その Webhook は無効になり、通知が止まります(無効なwebhookの停止処理の追加)。無効にしたことを知らせるメールも届きます(Webhookの失敗を知らせるメール)
無効になったら、受け口を直してから有効にし直してください
受け口が上の条件を満たしているかを確かめてから、クラウド管理画面の「高度な機能」→「お知らせ機能」→「通知先」を開きます。無効になった Webhook は「有効」の列が「無効」になっているので、編集の画面で「有効」にチェックを入れてください。
関連記事
※ 3秒以内の応答は、リリースノート「無効なwebhookの停止処理の追加」によります。再送の回数は、2026年10月21日に確かめた今の動きです。