トリガー CLI コマンド

トリガーを作成し、そのURL、ユーザー名、パスワードを受け取る。

triggers create --name NAME [--kind cap|overlay] (--tag TAG | --screen-id ID...) [--for DURATION] [--pull FILE]
    [--show bar|takeover] [--edge bottom|top] [--style FILE] [--map FILE] [--signing]
    [--verify VENDOR [--verify-secret-file FILE] [--verify-header NAME] [--verify-encoding hex|base64]
        [--verify-timestamp-header NAME] [--verify-tolerance SECONDS]]
    [--handshake VENDOR]

screenrig triggers create --name "Campus alerts" --tag Campus
screenrig triggers create --name "Campus alerts" --tag Campus --pull pull.json
screenrig triggers create --name "Lobby sensors" --kind overlay --show bar --tag Lobby
screenrig triggers create --name "Doorbell" --kind overlay --show takeover --tag Lobby --for 30s
screenrig triggers create --name "Payments" --kind overlay --show bar --tag Lobby --verify stripe --verify-secret-file stripe.secret --map stripe-map.json
screenrig triggers create --name "Boards" --kind overlay --show bar --tag Lobby --handshake trello

エンベロープは、data.url（https://api.screenrig.ai/api/triggers/<id>/cap、オーバーレイトリガーでは .../overlay）、data.username（トリガー ID）、data.password を含むトリガーです。今すぐ送信元のシステムに設定してください。オーバーレイトリガーの送信元には URL とパスワードが必要です（Authorization: Bearer）。--signing を付けると、エンベロープに data.signing_secret も一度だけ入り、警告 trigger_signing_secret_shown_once が付きます。作成が中断または不明確になった場合は、24 時間以内に同じコマンドをもう一度実行してください。保存済みの冪等キーが再利用され、サーバーは新たに作成せず同じトリガーとパスワードを返します。

--pull は、投稿された URL（引き続き有効）に加えてプラットフォームが参照するソースを追加します。オブジェクトには sources（CAP 1.0〜1.2 のアラートまたは ATOM／RSS インデックスの http または https URL 最大5件）、publicAlerts, location（name, latitude, longitude, geocodes を [{name, value}] として）、minSeverity, maxSeverity, minUrgency, minCertainty, events, excludeEvents, senders, statuses, scopes, languages, areaUnknown が含まれます。feeds get cap にはフラグと同じフィルターを指定できます。location は sources が指定されていない場合必須で、sources がない場合は location をカバーする公開フィードが読み込まれます。各ソースは1分ごとに取得されます。最も深刻な一致アラートが投稿済みアラート同様にスクリーンを制御し、ソースにアラートがない場合は取得アラートが終了します。古いまたは失敗したソースではアラートは終了しません。例：{"location": {"latitude": 49.25, "longitude": -123}, "minSeverity": "moderate"}。

オーバーレイ用のオプション（--show、--edge、--style、--map、--signing、--verify とその関連オプション、--handshake）には --kind overlay が必要で、--pull は CAP トリガーに必要です。--style、--map、--verify-secret-file はそれぞれファイルを読み取りますが、-（stdin）を読み取れるのはそのうち 1 つだけです。

--verify VENDOR を使うと、ベンダー自身の Webhook が data.url に直接投稿できます。ベンダーの有効な署名が独自のヘッダーに付いた投稿は、data.password なしで受け付けられます。この認証も引き続き並行して使えます。ベンダーのシークレットは封印されて保存され、overlay.verify.secret として set と末尾 4 文字だけが読み取れます。asana はシークレットを取りません。ハンドシェイクが配信するため、それまでイベントは secret_pending を返します。generic_hmac には --verify-header が必要で、--verify-encoding、--verify-timestamp-header、--verify-tolerance を指定できます。--handshake VENDOR は、認証情報を求める前にそのベンダーのセットアップチャレンジに応答します。アラートは変更せず、課金もされず、triggers deliveries には結果 handshake として表示されます。ベンダー、そのヘッダー、各ベンダーで入力する設定はベンダーの署名とハンドシェイクに一覧があります。

このプロジェクトのトリガーと最新アラートを古い順に一覧表示

triggers list

screenrig triggers list

--human は ID、KIND、LABEL、TARGET、ALERT、LAST_RECEIVED を表示します。オーバーレイトリガーでは、ALERT に描画内容と保持中のアラート数が表示されます。一覧にはパスワードも署名シークレットも含まれません。

トリガーとその最新アラートを検査。

triggers show <id>

screenrig triggers show trg_01EXAMPLETRIGGER00

data.alert は最新のアラートです。CAP フィールド、state active または ended（ended_reason cancelled、all_clear、cleared、expired を伴う）、until、そして screens（targeted、taken_over、cleared、skipped、failed、pending）です。pending は画面への書き込みが続いている間は true で、失敗した画面は再試行されます。data.playlist_id はトリガーのアラート用プレイリストで、screen show はアラートをそのプレイリストの引き継ぎとして報告します。オーバーレイトリガーでは、data.overlay に show、edge、enabled、signing、verify、handshake（設定されている間のみ）、card_id、alerts（有効なアラート、新しい順。先頭が表示中）、screens（targeted、holding、taken_over、removed、edge_taken、skipped、failed）、pending が入ります。

トリガーのスクリーンに60秒の運動アラートを表示。

triggers test <id>

screenrig triggers test trg_01EXAMPLETRIGGER00

エンベロープは受領証です: data.outcome shown と data.alert。すべての画面への書き込みが終わる前に応答が返ります。triggers show で件数を確認できます。オーバーレイトリガーはアラート screenrig-test（ラベル Test、タイトル Test overlay）を 60 秒間表示し、受領証は送信と同じです（data.alert_id、data.until、data.active）。どちらの種類も、アラート表示中のテストは拒否します。

URL とシークレットを変えずにトリガーを変更します。

triggers update <id> [--name NAME] [--tag TAG | --screen-id ID...] [--for DURATION] [--pull FILE | --no-pull]
    [--edge bottom|top] [--style FILE | --clear-style] [--map FILE | --clear-map] [--enable | --disable]
    [--signing | --no-signing]
    [--verify VENDOR [--verify-secret-file FILE] [--verify-header NAME] [--verify-encoding hex|base64]
        [--verify-timestamp-header NAME] [--verify-tolerance SECONDS] | --clear-verify]
    [--handshake VENDOR | --clear-handshake] [--expect-rev REVISION]

screenrig triggers update trg_01EXAMPLETRIGGER00 --tag Lobby
screenrig triggers update trg_01EXAMPLETRIGGER00 --edge top --style style.json
screenrig triggers update trg_01EXAMPLETRIGGER00 --map map.json --signing
screenrig triggers update trg_01EXAMPLETRIGGER00 --verify github --verify-secret-file github.secret
screenrig triggers update trg_01EXAMPLETRIGGER00 --clear-verify

--expect-rev 以外に少なくとも 1 つのオプションが必要です。ストリップは新しい対象画面と端に置き直されます。引き継ぎトリガーの新しい対象は、次に始まるアラートから適用されます。すでに署名しているトリガーは、--signing を繰り返しても署名シークレットを保ちます。置き換えるには triggers rotate-secret --signing を使います。--clear-verify はベンダーの検証とそのシークレットを削除し、--clear-handshake はベンダーのハンドシェイクへの応答をやめます。更新が中断または不明確になった場合は、同じコマンドをもう一度実行してください。保存済みの冪等キーが再利用されます。

オーバーレイトリガーの送信ログを読みます。各送信が表示・無視・拒否された理由がわかります。

triggers deliveries <id> [--limit N]

screenrig triggers deliveries trg_01EXAMPLETRIGGER00 --limit 20

data.items には、過去 7 日間の送信が入っています: at、outcome (shown、updated、unchanged、ended、ignored、refused、invalid、handshake)、拒否または無効な送信の reason (credentials、signature、signature_missing、signature_invalid、timestamp_missing、timestamp_stale、secret_pending、handshake_invalid、disabled、body、mapping、field、rate_limited、internal)、detail (誤っていたメンバーまたはマッピングのパス)、status、bytes、files (マルチパート送信のファイル部分。無視されます)、alert_id、request_id。signature は失敗した ScreenRig-Signature です。そのほかの署名、タイムスタンプ、ハンドシェイクの理由はベンダーのもので、ベンダーの署名とハンドシェイクの表で説明しています。ログには本文、ヘッダー、認証情報は残りません。誤ったシークレット、不正な署名、無効なトリガーは、すべて送信元に同じ 404 を返すため、どれだったかはこのログで確認します。CAP トリガーには配信がありません。

トリガーのアラートを今すぐ終了する。

triggers clear <id> [--alert-id ID]

screenrig triggers clear trg_01EXAMPLETRIGGER00
screenrig triggers clear trg_01EXAMPLETRIGGER00 --alert-id front-door

アラートは ended_reason cleared で終了し、画面はそれまで再生していた内容に戻ります。その後ほかの引き継ぎに置き換えられた画面はそのままです。有効なアラートがなければ何も変わりません。オーバーレイトリガーでは、有効でないアラートの解除は何も変えず、最後のアラートが終わるとストリップが消えるか、引き継ぎの画面が戻ります。

トリガーのパスワードを置き換えます。

triggers rotate-secret <id> [--signing] [--expect-rev REVISION]

screenrig triggers rotate-secret trg_01EXAMPLETRIGGER00

エンベロープの data.password に新しいパスワードが入ります。古いパスワードはすぐに使えなくなるので、新しいものを送信元のシステムに設定してください。--signing を指定すると、代わりに新しい data.signing_secret が一度だけ入り、古いものはすぐに使えなくなります。署名しないトリガーは invalid_request を返します。中断またはあいまいなローテーションの後は、24 時間以内に同じコマンドを再実行してください。保存された冪等キーが再利用され、サーバーは再度ローテーションせず、すでに行われたローテーションを返します。

トリガーを削除します。URL はすぐにアラートと送信を受け付けなくなり、オーバーレイトリガーのストリップは画面から外れ、そのカードは削除されます。アラートを表示中のトリガーは resource_conflict で拒否されます。先に triggers clear を実行してください。

triggers delete <id> [--expect-rev REVISION]

screenrig triggers delete trg_01EXAMPLETRIGGER00