本指南教您如何使用 Webhook 在 Meilisearch 完成任务时通知某个 URL。

​
要求

  • 命令行控制台
  • 自托管的 Meilisearch 实例
  • 配置为接收带有 ndjson 负载的 POST 请求的服务器

​
配置 Webhook URL

重启您的 Meilisearch 实例，并向 --task-webhook-URL 提供 Webhook URL

meilisearch --task-webhook-url http://localhost:8000

您也可以使用环境变量或在配置文件中使用 MEILI_TASK_WEBHOOK_URL 定义 Webhook URL。

​
可选：配置授权头

根据您的设置，您可能需要提供授权头。将其提供给 task-webhook-authorization-header

meilisearch --task-webhook-url http://localhost:8000 --task-webhook-authorization-header Bearer aSampleMasterKey

​
测试 Webhook

常见的异步操作是将文档添加或更新到索引。以下示例将一个测试文档添加到我们的 books 索引

curl \
  -X POST 'MEILISEARCH_URL/indexes/books/documents' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    {
      "id": 1,
      "title": "Nuestra parte de noche",
      "author": "Mariana Enríquez"
    }
  ]'

当 Meilisearch 完成此文档的索引时，它将向您使用 --task-webhook-url 配置的 URL 发送一个 POST 请求。请求正文将是一个或多个采用 ndjson 格式的任务对象

{"uid":4,"indexUid":"books","status":"succeeded","type":"documentAdditionOrUpdate","canceledBy":null,"details.receivedDocuments":1,"details.indexedDocuments":1,"duration":"PT0.001192S","enqueuedAt":"2022-08-04T12:28:15.159167Z","startedAt":"2022-08-04T12:28:15.161996Z","finishedAt":"2022-08-04T12:28:15.163188Z"}

如果 Meilisearch 批量处理了多个任务，它只会在批处理中的所有任务完成后触发一次 Webhook。在这种情况下，响应负载将包含所有任务，每个任务由一个新行分隔

{"uid":4,"indexUid":"books","status":"succeeded","type":"documentAdditionOrUpdate","canceledBy":null,"details.receivedDocuments":1,"details.indexedDocuments":1,"duration":"PT0.001192S","enqueuedAt":"2022-08-04T12:28:15.159167Z","startedAt":"2022-08-04T12:28:15.161996Z","finishedAt":"2022-08-04T12:28:15.163188Z"}
{"uid":5,"indexUid":"books","status":"succeeded","type":"documentAdditionOrUpdate","canceledBy":null,"details.receivedDocuments":1,"details.indexedDocuments":1,"duration":"PT0.001192S","enqueuedAt":"2022-08-04T12:28:15.159167Z","startedAt":"2022-08-04T12:28:15.161996Z","finishedAt":"2022-08-04T12:28:15.163188Z"}
{"uid":6,"indexUid":"books","status":"succeeded","type":"documentAdditionOrUpdate","canceledBy":null,"details.receivedDocuments":1,"details.indexedDocuments":1,"duration":"PT0.001192S","enqueuedAt":"2022-08-04T12:28:15.159167Z","startedAt":"2022-08-04T12:28:15.161996Z","finishedAt":"2022-08-04T12:28:15.163188Z"}