使用 /webhooks 在 Meilisearch 完成任务处理时触发自动工作流。

​
Webhook 对象

{
  "uuid": "V4_UUID_GENERATED_BY_MEILISEARCH",
  "url": "WEBHOOK_NOTIFICATION_TARGET_URL",
  "headers": {
    "HEADER": "VALUE",
  },
  "isEditable": false
}
  • uuid：当您创建新 webhook 时 Meilisearch 自动生成的 v4 uuid
  • url：一个字符串，指示 Meilisearch 在完成任务时应通知的 URL，必填
  • headers：一个包含 HTTP 标头及其值的对象，可选，通常用于身份验证
  • isEditable：只读布尔字段，指示是否可以编辑 webhook。Meilisearch 会自动将其设置为通过 API 创建的所有 webhook 为 true，为保留的 webhook 设置为 false

​
Webhook 有效负载

当 Meilisearch 完成任务处理时，它会将相关的任务对象发送到所有配置的 webhook。

​
获取所有 Webhook

GET
/webhooks
获取当前 Meilisearch 实例中配置的所有 webhook 列表。

​
示例

curl \
  -X GET 'MEILISEARCH_URL/webhooks'

​
响应：200 OK

{
  "results": [
    {
      "uuid": "UUID_V4",
      "url": "WEBHOOK_TARGET_URL",
      "headers": {
        "HEADER": "VALUE",
      },
      "isEditable": false
    },
    {
      "uuid": "UUID_V4",
      "url": "WEBHOOK_TARGET_URL",
      "headers": null,
      "isEditable": true
    }
  ]
}

​
获取单个 Webhook

GET
/webhooks/{uuid}
获取当前 Meilisearch 实例中配置的单个 webhook。

​
示例

​
响应：200 OK

{
  "uuid": "UUID_V4",
  "url": "WEBHOOK_TARGET_URL",
  "headers": {
    "HEADER": "VALUE",
  },
  "isEditable": false
}

​
创建 Webhook

POST
/webhooks
创建一个新的 webhook。当 Meilisearch 完成任务处理时，它会将相关的任务对象发送到所有配置的 webhook。 您可以创建最多 20 个 webhook。同时激活多个 webhook 可能会对性能产生负面影响。

​
示例

curl \
  -X POST 'MEILISEARCH_URL/webhooks' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "url": "WEBHOOK_TARGET_URL",
    "headers": {
      "authorization": "SECURITY_KEY",
      "referer": "https://example.com"
    }
  }'

​
响应：200 OK

{
  "uuid": "627ea538-733d-4545-8d2d-03526eb381ce",
  "url": "WEBHOOK_TARGET_URL",
  "headers": {
    "authorization": "SECURITY_KEY",
    "referer": "https://example.com",
  },
  "isEditable": true
}

​
更新 Webhook

PATCH
/webhooks/{uuid}
更新指定 webhook 的配置。要删除某个字段，请将其值设置为 null。
无法编辑 isEditable 字段设置为 false 的 webhook。Meilisearch Cloud 可能会创建内部 webhook 以支持分析和监控等功能。这些 webhook 始终是 isEditable: false。

​
示例

curl \
  -X PATCH 'MEILISEARCH_URL/webhooks/WEBHOOK_UUID' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "header": {
      "referer": null
    }
  }'

​
响应：200 OK

{
  "uuid": "627ea538-733d-4545-8d2d-03526eb381ce",
  "url": "WEBHOOK_TARGET_URL",
  "headers": {
    "authorization": "SECURITY_KEY"
  },
  "isEditable": true
}

​
删除 Webhook

DELETE
/webhooks/{uuid}
删除 webhook 并停止向目标 URL 发送任务完成数据。
无法删除 isEditable 字段设置为 false 的 webhook。

​
示例

curl \
  -X DELETE 'MEILISEARCH_URL/webhooks/WEBHOOK_UUID'

​
响应：204 无内容

© . This site is unofficial and not affiliated with Meilisearch.