This document is translated by the community. You can contribute on Crowdin. We appreciate your cooperation 🙏.
Webhook
This feature is available in version 12.109.0 and later.
This feature is experimental. It may be unstable and its specifications may be subject to change.
Misskey provides webhooks. Using webhooks, you can receive events from Misskey in realtime.
You can manage your webhooks in Settings > Webhook
Once a webhook is registered, Misskey will send an HTTP request to the specified URL when the specified event occurs. These requests are POST requests with a JSON body. The header field X-Misskey-Hook-Secret will contain the secret specified on creation. For security, you should verify the content of this field matches the secret provided during creation.
The request payload contains the following properties: TBA
If the destination server returns a 500 error or does not respond, Misskey will try again later.
Webhooks can be temporarily enabled or disabled from their settings page.
Events
The following are the available events and their payloads.
follow
followed
unfollow
note
reply
renote
mention
Occurs when you are mentioned.