钩子

Webhooks 让你可以订阅程序运行过程中发生的事件，并且当事件发生时，自动将数据传输到你的服务器。当 Memos 上发生某些事件时，Webhook 提供了一种可以将通知发送到外部服务器的方法。

使用 Webhooks

Webhooks 用于分发与记录的创建、更新、删除相关的事件。

创建 webhook 时，你需要指定一个地址。当你订阅的事件发生时， Memos 将向指定的 URL 发送一个包含有关该事件的 JSON 数据的 HTTP POST 请求。如果你的服务器正在监听该 URL 上的请求，那么你的服务器将可以在收到 webhook 传输的数据后采取其它行动。

Webhook 发送的数据包含有关记录及其相关资源和关系的信息，具体结构如下：

• activityType：一个字符串，表示当前的动作类型。可能的值如下：

• memos.memo.created
• memos.memo.updated
• memos.memo.deleted

• creatorId：创建者 ID。

• createTime：webhook 负载创建的时间戳。

• memo：记录的详细信息，包含 ID 以及内容。如果你需要记录的更多信息，你可以通过 Memos API，使用记录 ID 来获取记录的详情。

• url：Webhook 的 URL。

一旦你的服务器配置好用于接受 webhook 请求，它将监听发送到的任何请求。

注意

为了确保你的服务器仅会处理由你的 Memos 发出的请求，同时确保该请求未被篡改，在处理 Memos webhook 请求之前，应该先验证 webhook 签名。

Memos API

Memos API