Webhook

提示

バージョン 12.109.0 以降の機能です。

注意

実験的な機能であるため、動作が不安定だったり今後仕様が変更される可能性があります。

MisskeyにはWebhookが用意されています。Webhookを利用すると、Misskey上の様々なイベントをリアルタイムに受け取ることが可能です。

設定 > WebhookでWebhookの管理を行えます。

Webhookが登録されると、指定したイベントが発生した際に、指定したURLにHTTPリクエストが送信されます。リクエストのメソッドはPOSTで、ボディはJSONです。さらに、リクエストヘッダーにはX-Misskey-Hook-Secretという名前で、登録時に設定したシークレットが含まれます。このシークレットが正しいか検証することで、リクエストが正規のものか判定することができます。

リクエストペイロードは以下のプロパティが入ります。

送信先サーバーが5xxエラーを返すか、応答しなかった場合は時間を開けてリクエストが再送されます。

Webhookは管理画面から個別にアクティブ状態を設定でき、一時的にリクエストの送信を停止させることができます。