Webhook
関連API
- POST - /v1/users/<username>/webhooks
- 新たな Webhook を作成するための API です。
- GET - /v1/users/<username>/webhooks
<username>で指定されたユーザーに対して既に作成済みの Webhook の一覧を取得するための API です。
- POST - /v1/users/<username>/webhooks/<webhookHash>
- 作成済みの Webhook による処理の実行を行うための API です。
- DELETE - /v1/users/<username>/webhooks/<webhookHash>
- 作成済みの Webhook を削除するための API です。
特徴
作成済みの Webhook への起動のためのリクエストの際には、HTTPヘッダーへの認証情報の設定をする必要がありません。
Webhook をあらかじめ作成しておくことで、一部のスマートスピーカーなどの、任意のHTTPヘッダーを設定することができないクライアントから値のリアルタイムなレコーディングを行うことができるようになります。
仕様
increment
decrement
add
subtract
stopwatch
留意事項
- 処理の実行の際に認証情報を必要としないため、
<webhookHash>が第三者に知られてしまうと、誰でもその処理を実行できてしまう点に注意してください。
- Webhook を作成する際、
quantityプロパティを指定することができます（POST - /v1/users/<username>/webhooks - Pixela API Document）。このプロパティは、addおよびsubtracttype の Webhook のためのものです。 quantityプロパティに何も設定されていない状態でaddやsubtractの Webhook が起動された場合、デフォルト値として1もしくは0.01の値が用いられます。incremenetdecrementstopwatchtype の Webhook にquantityプロパティを設定することは可能ですが、その設定は何にも使用されません。