jointrashposs/content/tw/docs/2.for-users/3.features/webhook.md

155 lines
3.6 KiB
Markdown
Raw Normal View History

New Crowdin updates (#24) * New translations 1.about-misskey.md (Chinese Simplified) * New translations 1.about-misskey.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations 0.index.md (Chinese Simplified) * New translations 0.index.md (Chinese Traditional) * New translations 1.warning.md (Chinese Simplified) * New translations 1.warning.md (Chinese Traditional) * New translations 2.get-started.md (Chinese Simplified) * New translations 2.get-started.md (Chinese Traditional) * New translations 3.join-server.md (Chinese Simplified) * New translations 3.join-server.md (Chinese Traditional) * New translations 4.things-to-know.md (Chinese Simplified) * New translations 4.things-to-know.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations ads.md (Chinese Simplified) * New translations ads.md (Chinese Traditional) * New translations antenna.md (Chinese Simplified) * New translations antenna.md (Chinese Traditional) * New translations charts.md (Chinese Simplified) * New translations charts.md (Chinese Traditional) * New translations clip.md (Chinese Simplified) * New translations clip.md (Chinese Traditional) * New translations custom-emoji.md (Chinese Simplified) * New translations custom-emoji.md (Chinese Traditional) * New translations deck.md (French) * New translations deck.md (Italian) * New translations deck.md (Korean) * New translations deck.md (Polish) * New translations deck.md (Chinese Simplified) * New translations deck.md (Chinese Traditional) * New translations deck.md (English) * New translations drive.md (Chinese Simplified) * New translations drive.md (Chinese Traditional) * New translations favorite.md (Chinese Simplified) * New translations favorite.md (Chinese Traditional) * New translations follow.md (Chinese Simplified) * New translations follow.md (Chinese Traditional) * New translations hashtag.md (Chinese Simplified) * New translations hashtag.md (Chinese Traditional) * New translations mention.md (Chinese Simplified) * New translations mention.md (Chinese Traditional) * New translations mfm.md (Chinese Simplified) * New translations mfm.md (Chinese Traditional) * New translations mute-and-block.md (Chinese Simplified) * New translations mute-and-block.md (Chinese Traditional) * New translations pages.md (Chinese Simplified) * New translations pages.md (Chinese Traditional) * New translations plugin.md (Chinese Simplified) * New translations plugin.md (Chinese Traditional) * New translations poll.md (Chinese Simplified) * New translations poll.md (Chinese Traditional) * New translations reaction.md (Chinese Simplified) * New translations reaction.md (Chinese Traditional) * New translations share-form.md (Chinese Simplified) * New translations share-form.md (Chinese Traditional) * New translations silence.md (Chinese Simplified) * New translations silence.md (Chinese Traditional) * New translations theme.md (Chinese Simplified) * New translations theme.md (Chinese Traditional) * New translations thread-mute.md (Chinese Simplified) * New translations thread-mute.md (Chinese Traditional) * New translations timeline.md (Chinese Simplified) * New translations timeline.md (Chinese Traditional) * New translations webhook.md (French) * New translations webhook.md (Italian) * New translations webhook.md (Korean) * New translations webhook.md (Polish) * New translations webhook.md (Chinese Simplified) * New translations webhook.md (Chinese Traditional) * New translations webhook.md (English) * New translations widgets.md (Chinese Simplified) * New translations widgets.md (Chinese Traditional) * New translations word-mute.md (French) * New translations word-mute.md (Italian) * New translations word-mute.md (Korean) * New translations word-mute.md (Polish) * New translations word-mute.md (Chinese Simplified) * New translations word-mute.md (Chinese Traditional) * New translations word-mute.md (English) * New translations 1.troubleshooting.md (Chinese Simplified) * New translations 1.troubleshooting.md (Chinese Traditional) * New translations apps.md (Chinese Simplified) * New translations apps.md (Chinese Traditional) * New translations donate.md (French) * New translations donate.md (Italian) * New translations donate.md (Korean) * New translations donate.md (Polish) * New translations donate.md (Chinese Simplified) * New translations donate.md (Chinese Traditional) * New translations donate.md (English) * New translations faq.md (Chinese Simplified) * New translations faq.md (Chinese Traditional) * New translations glossary.md (Chinese Simplified) * New translations glossary.md (Chinese Traditional) * New translations misskey-hub.md (Chinese Simplified) * New translations misskey-hub.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations announcement.md (Chinese Simplified) * New translations announcement.md (Chinese Traditional) * New translations ftt.md (Chinese Simplified) * New translations ftt.md (Chinese Traditional) * New translations role.md (French) * New translations role.md (Italian) * New translations role.md (Korean) * New translations role.md (Polish) * New translations role.md (Chinese Simplified) * New translations role.md (Chinese Traditional) * New translations role.md (English) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations bash.md (French) * New translations bash.md (Italian) * New translations bash.md (Korean) * New translations bash.md (Polish) * New translations bash.md (Chinese Simplified) * New translations bash.md (Chinese Traditional) * New translations bash.md (English) * New translations docker.md (French) * New translations docker.md (Italian) * New translations docker.md (Korean) * New translations docker.md (Polish) * New translations docker.md (Chinese Simplified) * New translations docker.md (Chinese Traditional) * New translations docker.md (English) * New translations kubernetes.md (French) * New translations kubernetes.md (Italian) * New translations kubernetes.md (Korean) * New translations kubernetes.md (Polish) * New translations kubernetes.md (Chinese Simplified) * New translations kubernetes.md (Chinese Traditional) * New translations kubernetes.md (English) * New translations manual.md (Chinese Simplified) * New translations manual.md (Chinese Traditional) * New translations ubuntu-manual.md (Chinese Simplified) * New translations ubuntu-manual.md (Chinese Traditional) * New translations cdn.md (Chinese Simplified) * New translations cdn.md (Chinese Traditional) * New translations nginx.md (Chinese Simplified) * New translations nginx.md (Chinese Traditional) * New translations push-docker-hub.md (French) * New translations push-docker-hub.md (Italian) * New translations push-docker-hub.md (Korean) * New translations push-docker-hub.md (Polish) * New translations push-docker-hub.md (Chinese Simplified) * New translations push-docker-hub.md (Chinese Traditional) * New translations push-docker-hub.md (English) * New translations scale-out.md (Chinese Simplified) * New translations scale-out.md (Chinese Traditional) * New translations troubleshooting.md (Chinese Simplified) * New translations troubleshooting.md (Chinese Traditional) * New translations disable-timelines.md (Chinese Simplified) * New translations disable-timelines.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations libraries.md (Chinese Simplified) * New translations libraries.md (Chinese Traditional) * New translations permission.md (Chinese Simplified) * New translations permission.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations global-timeline.md (French) * New translations global-timeline.md (Italian) * New translations global-timeline.md (Korean) * New translations global-timeline.md (Polish) * New translations global-timeline.md (Chinese Simplified) * New translations global-timeline.md (Chinese Traditional) * New translations global-timeline.md (English) * New translations home-timeline.md (French) * New translations home-timeline.md (Italian) * New translations home-timeline.md (Korean) * New translations home-timeline.md (Polish) * New translations home-timeline.md (Chinese Simplified) * New translations home-timeline.md (Chinese Traditional) * New translations home-timeline.md (English) * New translations hybrid-timeline.md (French) * New translations hybrid-timeline.md (Italian) * New translations hybrid-timeline.md (Korean) * New translations hybrid-timeline.md (Polish) * New translations hybrid-timeline.md (Chinese Simplified) * New translations hybrid-timeline.md (Chinese Traditional) * New translations hybrid-timeline.md (English) * New translations index.md (Chinese Simplified) * New translations index.md (Chinese Traditional) * New translations local-timeline.md (French) * New translations local-timeline.md (Italian) * New translations local-timeline.md (Korean) * New translations local-timeline.md (Polish) * New translations local-timeline.md (Chinese Simplified) * New translations local-timeline.md (Chinese Traditional) * New translations local-timeline.md (English) * New translations main.md (French) * New translations main.md (Italian) * New translations main.md (Korean) * New translations main.md (Polish) * New translations main.md (Chinese Simplified) * New translations main.md (Chinese Traditional) * New translations main.md (English) * New translations note-capture-events.md (French) * New translations note-capture-events.md (Italian) * New translations note-capture-events.md (Korean) * New translations note-capture-events.md (Polish) * New translations note-capture-events.md (Chinese Simplified) * New translations note-capture-events.md (Chinese Traditional) * New translations note-capture-events.md (English) * New translations token.md (Chinese Simplified) * New translations token.md (Chinese Traditional) * New translations 1.index.md (Chinese Simplified) * New translations 1.index.md (Chinese Traditional) * New translations create-plugin.md (Chinese Simplified) * New translations create-plugin.md (Chinese Traditional) * New translations plugin-api-reference.md (Chinese Simplified) * New translations plugin-api-reference.md (Chinese Traditional) * New translations publish-on-your-website.md (Chinese Simplified) * New translations publish-on-your-website.md (Chinese Traditional) * New translations 5.releases.md (Chinese Simplified) * New translations 5.releases.md (Chinese Traditional)
2023-11-18 10:54:18 +01:00
# Webhook
:::tip
バージョン 12.109.0 以降の機能です。
:::
:::warning
実験的な機能であるため、動作が不安定だったり今後仕様が変更される可能性があります。
:::
MisskeyにはWebhookが用意されています。Webhookを利用すると、Misskey上の様々なイベントをリアルタイムに受け取ることが可能です。
設定>Webhook でWebhookの管理を行えます。
Webhookが登録されると、指定したイベントが発生した際に、指定したURLにHTTPリクエストが送信されます。リクエストのメソッドはPOSTで、ボディはJSONです。
さらに、リクエストヘッダーには`X-Misskey-Hook-Secret`という名前で、登録時に設定したシークレットが含まれます。このシークレットが正しいか検証することで、リクエストが正規のものか判定することができます。
リクエストペイロードは以下のプロパティが入ります。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
hookId: {
type: 'string',
description: 'Webhook ID',
},
userId: {
type: 'string',
description: 'Webhook作成者のユーザーID',
},
eventId: {
type: 'string',
description: 'イベントのID',
},
createdAt: {
type: 'integer',
description: 'イベントが発生した日時(UNIX time、ミリ秒)',
},
type: {
type: 'string',
description: 'イベントの種類',
},
body: {
type: 'object',
description: 'イベントのペイロード',
},
}
}"/>
送信先サーバーが5xxエラーを返すか、応答しなかった場合は時間を開けてリクエストが再送されます。
Webhookは管理画面から個別にアクティブ状態を設定でき、一時的にリクエストの送信を停止させることができます。
## イベント
イベントごとに説明とペイロードを示します。
### follow
自分が誰かをフォローした際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
user: {
$ref: 'misskey://User',
description: 'フォローしたユーザー',
},
}
}"/>
### followed
自分が誰かからフォローされた際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
user: {
$ref: 'misskey://User',
description: 'フォローを行ったユーザー',
},
}
}"/>
### unfollow
自分が誰かをフォロー解除した際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
user: {
$ref: 'misskey://User',
description: 'フォロー解除したユーザー',
},
}
}"/>
### note
自分がノートを投稿した際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: '作成されたノート',
},
}
}"/>
### reply
自分のノートに返信された際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: '返信',
},
}
}"/>
### renote
自分のートがRenoteされた際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: 'Renote',
},
}
}"/>
### mention
自分にメンションされた際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: 'メンションを含むノート',
},
}
}"/>