New translations webhook.md (English)

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

@@ -1,11 +1,15 @@
 # Webhook
 
 :::tip
+
 バージョン 12.109.0 以降の機能です。
+
 :::
 
 :::warning
+
 実験的な機能であるため、動作が不安定だったり今後仕様が変更される可能性があります。
+
 :::
 
 MisskeyにはWebhookが用意されています。Webhookを利用すると、Misskey上の様々なイベントをリアルタイムに受け取ることが可能です。
@@ -18,33 +22,33 @@ Webhookが登録されると、指定したイベントが発生した際に、
 リクエストペイロードは以下のプロパティが入ります。
 
 <MkSchemaViewerItemObject :schema="{
-type: 'object',
+ type: 'object',
-properties: {
+ properties: {
- hookId: {
+ 	hookId: {
- 	type: 'string',
+ 		type: 'string',
- 	description: 'Webhook ID',
+ 		description: 'Webhook ID',
- },
+ 	},
- userId: {
+ 	userId: {
- 	type: 'string',
+ 		type: 'string',
- 	description: 'Webhook作成者のユーザーID',
+ 		description: 'Webhook作成者のユーザーID',
- },
+ 	},
- eventId: {
+ 	eventId: {
- 	type: 'string',
+ 		type: 'string',
- 	description: 'イベントのID',
+ 		description: 'イベントのID',
- },
+ 	},
- createdAt: {
+ 	createdAt: {
- 	type: 'integer',
+ 		type: 'integer',
- 	description: 'イベントが発生した日時(UNIX time、ミリ秒)',
+ 		description: 'イベントが発生した日時(UNIX time、ミリ秒)',
- },
+ 	},
- type: {
+ 	type: {
- 	type: 'string',
+ 		type: 'string',
- 	description: 'イベントの種類',
+ 		description: 'イベントの種類',
- },
+ 	},
- body: {
+ 	body: {
- 	type: 'object',
+ 		type: 'object',
- 	description: 'イベントのペイロード',
+ 		description: 'イベントのペイロード',
- },
+ 	},
-}
+ }
 }"/>
 
 送信先サーバーが5xxエラーを返すか、応答しなかった場合は時間を開けてリクエストが再送されます。
@@ -57,22 +61,6 @@ Webhookは管理画面から個別にアクティブ状態を設定でき、一
 
 ### follow
 
-自分が誰かをフォローした際に発生します。
-
-<MkSchemaViewerItemObject :schema="{
-type: 'object',
-properties: {
- user: {
- 	$ref: 'misskey://User',
- 	description: 'フォローしたユーザー',
- },
-}
-}"/>
-
-### followed
-
-自分が誰かからフォローされた際に発生します。
-
 <MkSchemaViewerItemObject :schema="{
 type: 'object',
 properties: {
@@ -83,9 +71,17 @@ properties: {
 }
 }"/>
 
-### unfollow
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	user: {
+ 		$ref: 'misskey://User',
+ 		description: 'フォローしたユーザー',
+ 	},
+ }
+}"/>
 
-自分が誰かをフォロー解除した際に発生します。
+### followed
 
 <MkSchemaViewerItemObject :schema="{
 type: 'object',
@@ -97,9 +93,17 @@ properties: {
 }
 }"/>
 
-### note
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	user: {
+ 		$ref: 'misskey://User',
+ 		description: 'フォローを行ったユーザー',
+ 	},
+ }
+}"/>
 
-自分がノートを投稿した際に発生します。
+### unfollow
 
 <MkSchemaViewerItemObject :schema="{
 type: 'object',
@@ -111,9 +115,17 @@ properties: {
 }
 }"/>
 
-### reply
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	user: {
+ 		$ref: 'misskey://User',
+ 		description: 'フォロー解除したユーザー',
+ 	},
+ }
+}"/>
 
-自分のノートに返信された際に発生します。
+### note
 
 <MkSchemaViewerItemObject :schema="{
 type: 'object',
@@ -125,9 +137,17 @@ properties: {
 }
 }"/>
 
-### renote
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	note: {
+ 		$ref: 'misskey://Note',
+ 		description: '作成されたノート',
+ 	},
+ }
+}"/>
 
-自分のノートがRenoteされた際に発生します。
+### reply
 
 <MkSchemaViewerItemObject :schema="{
 type: 'object',
@@ -139,9 +159,17 @@ properties: {
 }
 }"/>
 
-### mention
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	note: {
+ 		$ref: 'misskey://Note',
+ 		description: '返信',
+ 	},
+ }
+}"/>
 
-自分にメンションされた際に発生します。
+### renote
 
 <MkSchemaViewerItemObject :schema="{
 type: 'object',
@@ -152,3 +180,27 @@ properties: {
  },
 }
 }"/>
+
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	note: {
+ 		$ref: 'misskey://Note',
+ 		description: 'Renote',
+ 	},
+ }
+}"/>
+
+### mention
+
+自分にメンションされた際に発生します。
+
+<MkSchemaViewerItemObject :schema="{
+ type: 'object',
+ properties: {
+ 	note: {
+ 		$ref: 'misskey://Note',
+ 		description: 'メンションを含むノート',
+ 	},
+ }
+}"/>