screenRIG
サインイン開始する

API リファレンス

Webhook API

Webhook：署名付きイベント配信

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

OpenAPI YAMLOpenAPI JSON問題 YAMLAPI の概要

このグループには 9 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

Webhook：署名付きイベント配信

GET/api/webhooks

Webhook 一覧

プロジェクトの Webhook 通知を Webhook 形式で古い順に一覧表示します（最大50件）。GET /api/notifications はすべてのチャネルを一覧表示します。署名シークレットはここでは返されません。プロジェクト権限が必要です。レポート専用の認証情報は、レスポンスに受信先 URL が含まれるため、403 forbidden で拒否されます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listWebhooks

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/webhooks'

レスポンス

ステータス意味本文とヘッダー
200プロジェクトのwebhookです。WebhookList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/webhooks

Webhookを作成

プロジェクト自身の耐久イベントを署名付きHTTPS POSTとして受信するWebhookを作成します。URLはパブリックインターネットホストのhttpsでなければなりません：IPリテラルまたは名前のすべての現在のDNS回答はパブリックである必要があります（プライベート、ループバック、リンクローカル、CGNAT、2000::/3外のIPv6、ドキュメント、その他の予約済み範囲はwebhook_url_rejectedで拒否されます）。

ポートは443（デフォルト）または8443でなければなりません。そうでなければwebhook_url_rejectedです。ホストは配信前に解決され再確認され、接続は正確に確認済みのアドレスにダイヤルされるため、後でDNS回答が変わっても配信はリダイレクトされません。event_typesは正確なイベントタイプ（screen.online）または末尾が.*のプレフィックス（screen.*）をリストします。

組織に作成できる通知は、すべてのチャネルを合わせて最大50件です（webhook_limit_reached）。署名シークレットはサーバーが生成し、この応答と rotate-secret でのみ返されます。保管してください。同じ Idempotency-Key を付けた同一内容の再試行には、シークレットを含む同じ応答が24時間返されます。

配信は notification.created の後の最初のイベントから始まります。

認証
projectBearer
リクエスト本文
Webhook書き込み
操作ID
createWebhook

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
URL（必須、文字列）ポート443（デフォルト）または8443のパブリックインターネットホストのhttps URL。ユーザー情報やフラグメントはありません。maxLength：2048 フォーマット：「uri」
event_types（必須、WebhookEventTypes）

screen.online のような完全一致のイベントタイプ、または screen.* のような .* で終わるプレフィックス（screen. で始まるすべてのタイプ）。notification.test は購読によって配信されることはなく、POST /api/webhooks/{id}/test でのみ送信されます。

enabled（任意、ブール値）true
説明（任意、文字列）maxLength：200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/webhooks'

レスポンス

ステータス意味本文とヘッダー
201作成されました。シークレットはここおよびシークレットのローテーション時にのみ表示されます。WebhookWithSecret（application/json）；ヘッダー：Cache-Control
400invalid_request または webhook_url_rejected。問題 (application/problem+json)
409webhook_limit_reached、idempotency_mismatch、またはプロジェクトがどの組織にも属していない場合は resource_conflict。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/webhooks/{id}

Webhook を取得

プロジェクト機能が必要です。レポート専用資格情報は受信者URLを含むため403禁止で拒否されます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
getWebhook

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/webhooks/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
2001つのWebhook。Webhook（application/json）；ヘッダー：ETag
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PATCH/api/webhooks/{id}

Webhookを更新

url、event_types、enabled、description（空の説明はクリア）を変更。新しいurlは作成時と同様にチェックされます。

無効な webhook に対して enabled を true に設定すると失敗状態がクリアされ、変更を記録したイベントから配信が開始されます。無効時のイベントは再生されず、無効前の保留中配信は webhook_disabled で失敗します。enabled を false に設定すると保留中配信は webhook_disabled で失敗します。

notification.updated を追加します。If-Match でリビジョンを保護します。

認証
projectBearer
リクエスト本文
Webhookパッチ
操作ID
updateWebhook

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。

リクエスト本文フィールド

フィールド説明
URL（任意、文字列）maxLength：2048 フォーマット：「uri」
event_types（任意、WebhookEventTypes）

screen.online のような完全一致のイベントタイプ、または screen.* のような .* で終わるプレフィックス（screen. で始まるすべてのタイプ）。notification.test は購読によって配信されることはなく、POST /api/webhooks/{id}/test でのみ送信されます。

enabled（任意、ブール値）
説明（任意、文字列）空文字列は説明をクリアします。maxLength：200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PATCH --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/webhooks/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
200Webhookを更新しました。Webhook（application/json）；ヘッダー：ETag
400invalid_request または webhook_url_rejected。問題 (application/problem+json)
412revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
削除/api/webhooks/{id}

Webhook削除

Webhook を削除し、notification.deleted を追加します。送信待ちの配信は webhook_deleted で失敗として扱われ、配信ログは参照できなくなり、イベント保持期間に合わせて期限切れになります。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
deleteWebhook

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/webhooks/RESOURCE_ID'

レスポンス

ステータス意味本文とヘッダー
204削除されました。本文なし；ヘッダー：Cache-Control
412revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/webhooks/{id}/rotate-secret

Webhook シークレットを回転

署名シークレットを置き換え、新しいシークレットを返します。古いシークレットは直ちに署名に使われなくなります。この更新が確定した後に署名されるすべての試行は新しいシークレットを使いますが、すでに送信中の試行が Webhook ごとに最大1件、古いシークレットで署名されたまま届くことがあるため、しばらくは両方を受け付けてください。notification.updated を details.changed [secret] とともに追加します。

完全一致する Idempotency-Key の正確な再試行は24時間同じ新しいシークレットを返します。

認証
projectBearer
リクエスト本文
なし
操作ID
rotateWebhookSecret

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
If-Matchヘッダーオプションオプションの正のリソースリビジョン。現在のリソースを書き込む場合は省略します。提供された古いリビジョンはrevision_conflictです。
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/webhooks/RESOURCE_ID/rotate-secret'

レスポンス

ステータス意味本文とヘッダー
200webhook と新しいシークレット。WebhookWithSecret（application/json）；ヘッダー：Cache-Control
412revision_conflict — If-Match が古くなっています。エラーの current_revision に現在のリビジョンが含まれます。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/webhooks/{id}/test

Webhookテスト

notification.test プロジェクトイベントを追加し、この Webhook のみに、そのイベントの配信を1件キューに入れます（他の Webhook が notification.test を受け取ることはありません）。無効な Webhook でも動作し、再試行なしで1回だけ試行され、他の配信と同様に従量課金の対象となり、Webhook の失敗状態は変更されません。結果は配信ログをポーリングして確認してください。

認証
projectBearer
リクエスト本文
なし
操作ID
testWebhook

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダーオプション新規操作のために省略します。再試行の重複排除にキーを供給し再利用してください。CLIがキーを自動管理します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/webhooks/RESOURCE_ID/test'

レスポンス

ステータス意味本文とヘッダー
202キューに入ったテスト配信。WebhookDelivery（application/json）；ヘッダー：RateLimit-Policy、RateLimit
429

安定した rate_limited 問題。権威ある Retry-After 間隔後にのみリトライしてください。固定ウィンドウ拒否は適用される RateLimit-Policy と RateLimit メンバーも含みます。並行性とバイト予算拒否はこれらの開示を省略します。

問題 (application/problem+json); ヘッダー: Retry-After, RateLimit-Policy, RateLimit
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/webhooks/{id}/deliveries

Webhook 配信一覧

webhook の配信ログ、新しいイベントが先頭。1行は(webhook, event)ごと。再試行は行を更新し、GET .../deliveries/{delivery_id}/attempts は最新の試行を一覧表示。行はイベントと同様に保持されます（プランのイベント保持期間、少なくとも24時間の再試行ウィンドウ）。次のページ用に前回と同様に next_cursor を返します。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listWebhookDeliveries

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
beforeクエリオプション前の配信ページの next_cursor。
制限クエリオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/webhooks/RESOURCE_ID/deliveries'

レスポンス

ステータス意味本文とヘッダー
2001ページの配信。WebhookDeliveryList（application/json）
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/webhooks/{id}/deliveries/{delivery_id}/attempts

Webhook 配信試行一覧

1つの配信の試行、最新20件を配信行と共に長期間保持。各試行には試行番号、終了時刻、受信者のHTTPステータス（応答なしはnull）、エラークラス（成功時はnull）、所要時間があります。レスポンスの本文とヘッダーは保持しません。試行記録がない配信はリストなし。

この webhook の配信でないか、別のプロジェクトの webhook の場合は not_found です。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listWebhookDeliveryAttempts

パラメーター

名前送信する必須？説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
delivery_idパス必須Webhookの配信IDの1つ。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/webhooks/RESOURCE_ID/deliveries/DELIVERY_ID/attempts'

レスポンス

ステータス意味本文とヘッダー
200配信の保持された試行回数です。WebhookDeliveryAttemptList（application/json）
404

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)