APIを使った開発のTIPs

Webhookでのイベント情報の取得|管理画面とAPIでの設定、ペイロードの例

取得できる情報

Webhookにてイベント情報を取得できます。詳細は:

                RemoteLOCKクラウド管理画面>「高度な機能」>「お知らせ機能」>「お知らせ機能の追加」 

お知らせ機能の追加画面でイベントタイプにWebhookを選ぶ

Webhook利用方法

Webhook利用方法には2パタンがあります。

  1. RemoteLOCKクラウド管理画面から設定

    参考文章:お知らせ機能|通知先の追加・お知らせの設定・メールとWebhookの通知例 

     

  2. API経由で設定

    参考資料:API仕様書 > P2  アクセスユーザー> Notification Subscribers  &  Notification Subscriptions 

 

ペイロード例

※:QRコードもしくはICカードで解錠した場合、JSON内の method の値は "smart_card"となっています。

{
  "data": {
    "type": "unlocked_event",
    "attributes": {
      "source": "user",
      "status": "succeeded",
      "time_zone": "Asia/Tokyo",
      "occurred_at": "2026-07-10T04:14:26Z",
      "created_at": "2026-07-10T04:14:35Z",
      "updated_at": "2026-07-10T04:14:35Z",
      "associated_resource_name": null,
      "status_info": null,
      "method": "smart_card",
      "pin": null,
      "card": "755656",
      "publisher_id": "48ed357c-a288-4213-a81a-8306b6b62604",
      "publisher_type": "connector_lock",
      "associated_resource_id": "91c5135b-f535-44ba-831a-2455192a6033",
      "associated_resource_type": "access_user"
    },
    "id": "f6c25e5c-6dce-4d61-ab4f-acb557134285",
    "links": {
      "self": "/events/f6c25e5c-6dce-4d61-ab4f-acb557134285",
      "publisher": "/devices/48ed357c-a288-4213-a81a-8306b6b62604",
      "associated_resource": "/access_persons/91c5135b-f535-44ba-831a-2455192a6033"
    }
  }
}

認証ヘッダなどを含め、フルサンプル

Webhookで受け取ったイベントのペイロード(JSON)の例

 

その他

制限やリトライに関して下記の文章をご参照ください。

 

 

 

最終更新

この記事は役に立ちましたか?

1人中0人がこの記事が役に立ったと言っています

記事で解決しないときは

問い合わせフォーム(24時間受付)か、お電話でご相談ください。