Skip to main content
GET
/
webhooks
cURL
curl \
  -X GET 'MEILISEARCH_URL/webhooks'
{
  "results": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "url": "https://your.site/on-tasks-completed",
      "headers": {
        "Authorization": "Bearer a-secret-token"
      },
      "isEditable": true
    },
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440001",
      "url": "https://another.site/on-tasks-completed",
      "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'
});

Response

Webhooks are returned.

Response containing a list of all registered webhooks.

​
results
object[]
required

All webhooks configured on the instance. Each entry includes UUID, URL, headers (authorization redacted), and editability.