page icon

Webhook

HTTPヘッダーへの認証情報の設定をすることなく 🪄Instant recording を行うことをサポートするためのAPI群です。

関連API

特徴

作成済みの Webhook への起動のためのリクエストの際には、HTTPヘッダーへの認証情報の設定をする必要がありません。
Webhook をあらかじめ作成しておくことで、一部のスマートスピーカーなどの、任意のHTTPヘッダーを設定することができないクライアントから値のリアルタイムなレコーディングを行うことができるようになります。

仕様

Webhook により行うことのできる処理は以下の3種類で、これは 🪄Instant recording で行える処理の種類と同等です。
 
  • increment
  • decrement
  • add
  • subtract
  • stopwatch
 
そのため、処理内容の詳細については 🪄Instant recording を参照してください。

留意事項

  • 処理の実行の際に認証情報を必要としないため、 <webhookHash> が第三者に知られてしまうと、誰でもその処理を実行できてしまう点に注意してください。
  • Webhook を作成する際、 quantity プロパティを指定することができます(POST - /v1/users/<username>/webhooks - Pixela API Document)。このプロパティは、 add および subtract type の Webhook のためのものです。
    • quantity プロパティに何も設定されていない状態で addsubtract の Webhook が起動された場合、デフォルト値として 1 もしくは 0.01 の値が用いられます。
    • incremenet decrement stopwatch type の Webhook に quantity プロパティを設定することは可能ですが、その設定は何にも使用されません。

関連リンク