HTTP request
curl \
-X PATCH 'MEILISEARCH_URL/webhooks/WEBHOOK_UUID' \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
--data-binary '{
"header": {
"referer": null
}
}'client.updateWebhook(WEBHOOK_UUID, {
headers: {
referer: null
}
})client.update_webhook('WEBHOOK_UID', {
'url': 'https://example.com/new-webhook',
'headers': {"Authorization":"", "X-Custom-Header":"test"},
})Webhook webhook = this.client.createWebhook(webhookReq1);
HashMap<String, Object> headers = new HashMap<>();
headers.put("referer", null);
CreateUpdateWebhookRequest webhookReq2 = new CreateUpdateWebhookRequest(webhook.getUrl(), headers);
Webhook updated_webhook = this.client.updateWebhook(webhook.getUuid(), webhookReq2);client.UpdateWebhook("WEBHOOK_UUID", &meilisearch.UpdateWebhookRequest{
Header: map[string]string{
"referer": ""
},
});let mut update = meilisearch_sdk::webhooks::WebhookUpdate::new();
update.remove_header("referer");
let webhook = client
.update_webhook("WEBHOOK_UUID", &update)
.await
.unwrap();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7700",
CURLOPT_URL => "http://localhost:7700/webhooks/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://your.site/on-tasks-completed',
'headers' => [
'Authorization' => 'Bearer a-secret-token'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("http://localhost:7700/webhooks/{uuid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://your.site/on-tasks-completed\",\n \"headers\": {\n \"Authorization\": \"Bearer a-secret-token\"\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://your.site/on-tasks-completed",
"headers": {
"Authorization": "Bearer a-secret-token"
},
"isEditable": true
}{
"message": "The webhook URL is invalid. Expected a valid URL.",
"code": "invalid_webhook_url",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#invalid_webhook_url"
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "The webhook was not found.",
"code": "webhook_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#webhook_not_found"
}Webhooks
Update webhook
Update the URL or headers of an existing webhook identified by its UUID.
PATCH
/
webhooks
/
{uuid}
HTTP request
curl \
-X PATCH 'MEILISEARCH_URL/webhooks/WEBHOOK_UUID' \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
--data-binary '{
"header": {
"referer": null
}
}'client.updateWebhook(WEBHOOK_UUID, {
headers: {
referer: null
}
})client.update_webhook('WEBHOOK_UID', {
'url': 'https://example.com/new-webhook',
'headers': {"Authorization":"", "X-Custom-Header":"test"},
})Webhook webhook = this.client.createWebhook(webhookReq1);
HashMap<String, Object> headers = new HashMap<>();
headers.put("referer", null);
CreateUpdateWebhookRequest webhookReq2 = new CreateUpdateWebhookRequest(webhook.getUrl(), headers);
Webhook updated_webhook = this.client.updateWebhook(webhook.getUuid(), webhookReq2);client.UpdateWebhook("WEBHOOK_UUID", &meilisearch.UpdateWebhookRequest{
Header: map[string]string{
"referer": ""
},
});let mut update = meilisearch_sdk::webhooks::WebhookUpdate::new();
update.remove_header("referer");
let webhook = client
.update_webhook("WEBHOOK_UUID", &update)
.await
.unwrap();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7700",
CURLOPT_URL => "http://localhost:7700/webhooks/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://your.site/on-tasks-completed',
'headers' => [
'Authorization' => 'Bearer a-secret-token'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("http://localhost:7700/webhooks/{uuid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://your.site/on-tasks-completed\",\n \"headers\": {\n \"Authorization\": \"Bearer a-secret-token\"\n }\n}"
response = http.request(request)
puts response.read_body{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"url": "https://your.site/on-tasks-completed",
"headers": {
"Authorization": "Bearer a-secret-token"
},
"isEditable": true
}{
"message": "The webhook URL is invalid. Expected a valid URL.",
"code": "invalid_webhook_url",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#invalid_webhook_url"
}{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}{
"message": "The webhook was not found.",
"code": "webhook_not_found",
"type": "invalid_request",
"link": "https://docs.meilisearch.com/errors#webhook_not_found"
}Authorizations
An API key is a token that you provide when making API calls. Read more about how to secure your project.
Include the API key to the Authorization header, for instance:
-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({
host: 'MEILISEARCH_URL',
apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});
Body
application/json
Response
Webhook updated successfully. Returns the webhook with metadata and redacted authorization headers.
Webhook object with metadata and redacted authorization headers.