Skip to content

Commit ca10026

Browse files
address reviewer feedback
1 parent 35de3ce commit ca10026

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

assets/misc/meilisearch-collection-postman.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3107,7 +3107,7 @@
31073107
],
31083108
"body": {
31093109
"mode": "raw",
3110-
"raw": "{\n \"name\": \"docs-key\",\n \"description\": \"Key to add and delete documents, in `books` index.\",\n \"actions\": [\n \"documents.add\",\n \"documents.delete\" \n ],\n \"indexes\": [\n \"books\"\n ],\n \"expiresAt\": null\n}"
3110+
"raw": "{\n \"url\": \"WEBHOOK_TARGET_URL\",\n \"headers\": {\n \"authorization\": \"SECURITY_KEY\",\n \"referer\": \"https://example.com\"\n }\n}"
31113111
},
31123112
"url": {
31133113
"raw": "{{url}}/webhooks",
@@ -3134,7 +3134,7 @@
31343134
],
31353135
"body": {
31363136
"mode": "raw",
3137-
"raw": "{\n \"description\": \"Key to add and delete documents, but also to create indexes, in `book` index.\"\n}"
3137+
"raw": "{\n \"header\": {\n \"referer\": null\n }\n}"
31383138
},
31393139
"url": {
31403140
"raw": "{{url}}/webhooks/WEBHOOK_UUID",

reference/api/keys.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Custom API keys are deterministic: `key` is a SHA256 hash of the `uid` and maste
7878
**Default value**: N/A<br />
7979
**Description**: An array of API actions permitted for the key, represented as strings. API actions are only possible on authorized [`indexes`](#indexes). `["*"]` for all actions.
8080

81-
You can use `*` as a wildcard to access all endpoints for the `documents`, `indexes`, `tasks`, `settings`, `stats` and `dumps` actions. For example, `documents.*` gives access to all document actions.
81+
You can use `*` as a wildcard to access all endpoints for the `documents`, `indexes`, `tasks`, `settings`, `stats`, `webhooks`, and `dumps` actions. For example, `documents.*` gives access to all document actions.
8282

8383
<Warning>
8484
For security reasons, we do not recommend creating keys that can perform all actions.

reference/api/webhooks.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Use the `/webhooks` to trigger automatic workflows when Meilisearch finishes pro
2828
- `uuid`: a v4 uuid Meilisearch automatically generates when you create a new webhook
2929
- `url`: a string indication the URL Meilisearch should notify whenever it completes a task, required
3030
- `headers`: an object with HTTP headers and their values, optional, often used for authentication
31-
- `isEditable`: read-only Boolean field indicating whether you can edit the webhook. Meilisearch automatically sets this to false for its internal webhooks
31+
- `isEditable`: read-only Boolean field indicating whether you can edit the webhook. Meilisearch automatically sets this to `true` for all webhooks created via the API and to `false` for reserved webhooks
3232

3333
## The webhook payload
3434

@@ -96,6 +96,8 @@ Get a single webhook configured in the current Meilisearch instance.
9696

9797
Create a new webhook. When Meilisearch finishes processing a task, it sends the relevant [task object](/reference/api/tasks#task-object) to all configured webhooks.
9898

99+
You can create up to 20 webhooks. Having multiple webhooks active at the same time may negatively impact performance.
100+
99101
### Example
100102

101103
<CodeSamplesWebhooksPost1 />

reference/errors/error_codes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The [`updatedAt`](/reference/api/indexes#index-object) field of an index cannot
8484

8585
### `immutable_webhook`
8686

87-
You tried to modify a reserved [webhook](/reference/api/webhooks). Reserved webhooks are configured by Meilisearch Cloud and have `isEditable` set to `true`. Webhooks created with an instance option are also ummutable.
87+
You tried to modify a reserved [webhook](/reference/api/webhooks). Reserved webhooks are configured by Meilisearch Cloud and have `isEditable` set to `true`. Webhooks created with an instance option are also immutable.
8888

8989
### `immutable_webhook_uuid`
9090

0 commit comments

Comments
 (0)