Create webhook

Register a new webhook to receive task completion notifications. You can optionally set custom headers (e.g. for authentication) and configure the callback URL.

POST /webhooks

cURL

cURL

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"
    }
  }'

201

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "url": "https://your.site/on-tasks-completed",
  "headers": {
    "Authorization": "Bearer a-secret-token"
  },
  "isEditable": true
}

Authorizations

Authorization · string · header · required

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

Configuration for a webhook endpoint

url · string | null

URL endpoint to call when tasks complete.

Example:

"https://your.site/on-tasks-completed"

headers · object

HTTP headers to include in webhook requests.

Show child attributes

Example:

{ "Authorization": "Bearer a-secret-token" }

Response

201

application/json

Webhook created successfully.

Webhook object with metadata and redacted authorization headers.

uuid · string<uuid> · required

Unique identifier of the webhook.

isEditable · boolean · required

Whether the webhook can be edited.

url · string | null

URL endpoint to call when tasks complete.

Example:

"https://your.site/on-tasks-completed"

headers · object

HTTP headers to include in webhook requests.

Show child attributes

Example:

{ "Authorization": "Bearer a-secret-token" }