Merge pull request #1169 from jawad-khan/jawad/webhooks-api

Add support for webhooks api

Author: Strift

.code-samples.meilisearch.yaml

@@ -767,3 +767,19 @@ get_batch_1: |-
   client.get_batch(BATCH_UID)
 get_similar_post_1: |-
   client.index("INDEX_NAME").get_similar_documents({"id": "TARGET_DOCUMENT_ID", "embedder": "default"})
+webhooks_get_1: |-
+  client.get_webhooks()
+webhooks_get_single_1: |-
+  client.get_webhook('WEBHOOK_UID')
+webhooks_post_1: |-
+  client.create_webhook({
+    'url': 'https://example.com/webhook',
+    'headers': {"Authorization":"", "X-Custom-Header":"test"},
+  })
+webhooks_patch_1: |-
+  client.update_webhook('WEBHOOK_UID', {
+    'url': 'https://example.com/new-webhook',
+    'headers': {"Authorization":"", "X-Custom-Header":"test"},
+  })
+webhooks_delete_1: |-
+  client.delete_webhook('WEBHOOK_UID')

meilisearch/client.py

@@ -32,6 +32,7 @@
 from meilisearch.index import Index
 from meilisearch.models.key import Key, KeysResults
 from meilisearch.models.task import Batch, BatchResults, Task, TaskInfo, TaskResults
+from meilisearch.models.webhook import Webhook, WebhooksResults
 from meilisearch.task import TaskHandler
 
 
@@ -465,6 +466,119 @@ def delete_key(self, key_or_uid: str) -> int:
 
         return response.status_code
 
+    # WEBHOOKS ROUTES
+
+    def get_webhooks(self) -> WebhooksResults:
+        """Get all webhooks.
+
+        Returns
+        -------
+        webhooks:
+            WebhooksResults instance containing list of webhooks and pagination info.
+            https://www.meilisearch.com/docs/reference/api/webhooks
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhooks = self.http.get(f"{self.config.paths.webhooks}")
+        return WebhooksResults(**webhooks)
+
+    def get_webhook(self, webhook_uuid: str) -> Webhook:
+        """Get information about a specific webhook.
+
+        Parameters
+        ----------
+        webhook_uuid:
+            The uuid of the webhook to retrieve.
+
+        Returns
+        -------
+        webhook:
+            The webhook information.
+            https://www.meilisearch.com/docs/reference/api/webhooks#get-one-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhook = self.http.get(f"{self.config.paths.webhooks}/{webhook_uuid}")
+        return Webhook(**webhook)
+
+    def create_webhook(self, options: Mapping[str, Any]) -> Webhook:
+        """Create a new webhook.
+
+        Parameters
+        ----------
+        options:
+            The webhook configuration. Can include:
+            - url: The URL to send the webhook to
+            - headers: Dictionary of HTTP headers to include in webhook requests
+
+        Returns
+        -------
+        webhook:
+            The newly created webhook.
+            https://www.meilisearch.com/docs/reference/api/webhooks#create-a-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhook = self.http.post(self.config.paths.webhooks, options)
+        return Webhook(**webhook)
+
+    def update_webhook(self, webhook_uuid: str, options: Mapping[str, Any]) -> Webhook:
+        """Update an existing webhook.
+
+        Parameters
+        ----------
+        webhook_uuid:
+            The uuid of the webhook to update.
+        options:
+            The webhook fields to update. Can include:
+            - url: The URL to send the webhook to
+            - headers: Dictionary of HTTP headers to include in webhook requests
+
+        Returns
+        -------
+        webhook:
+            The updated webhook.
+            https://www.meilisearch.com/docs/reference/api/webhooks#update-a-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        webhook = self.http.patch(f"{self.config.paths.webhooks}/{webhook_uuid}", options)
+        return Webhook(**webhook)
+
+    def delete_webhook(self, webhook_uuid: str) -> int:
+        """Delete a webhook.
+
+        Parameters
+        ----------
+        webhook_uuid:
+            The uuid of the webhook to delete.
+
+        Returns
+        -------
+        status_code:
+            The Response status code. 204 signifies a successful delete.
+            https://www.meilisearch.com/docs/reference/api/webhooks#delete-a-webhook
+
+        Raises
+        ------
+        MeilisearchApiError
+            An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://www.meilisearch.com/docs/reference/errors/error_codes#meilisearch-errors
+        """
+        response = self.http.delete(f"{self.config.paths.webhooks}/{webhook_uuid}")
+        return response.status_code
+
     def get_version(self) -> Dict[str, str]:
         """Get version Meilisearch
 

meilisearch/config.py

@@ -47,6 +47,7 @@ class Paths:
         localized_attributes = "localized-attributes"
         edit = "edit"
         network = "network"
+        webhooks = "webhooks"
 
     def __init__(
         self,

meilisearch/models/webhook.py

@@ -0,0 +1,22 @@
+from typing import Any, Dict, List, Optional
+
+from camel_converter.pydantic_base import CamelBase
+from pydantic import ConfigDict
+
+
+class Webhook(CamelBase):
+    """Model for a Meilisearch webhook."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    uuid: str
+    url: str
+    headers: Optional[Dict[str, Any]] = None
+    isEditable: bool
+
+
+class WebhooksResults(CamelBase):
+    """Model for webhooks list results."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+    results: List[Webhook]

tests/client/test_client_webhooks_meilisearch.py

@@ -0,0 +1,110 @@
+"""Tests for webhook management endpoints."""
+
+import pytest
+
+from meilisearch.errors import MeilisearchApiError
+
+
+def test_get_webhooks_empty(client):
+    """Test getting webhooks when none exist."""
+    webhooks = client.get_webhooks()
+    assert webhooks.results is not None
+    assert isinstance(webhooks.results, list)
+    assert len(webhooks.results) == 0
+
+
+def test_create_webhook(client):
+    """Test creating a webhook."""
+    webhook_data = {
+        "url": "https://example.com/webhook",
+        "headers": {
+            "Authorization": "Bearer secret-token",
+            "X-Custom-Header": "custom-value",
+        },
+    }
+
+    webhook = client.create_webhook(webhook_data)
+
+    assert webhook.uuid is not None
+    assert webhook.url == webhook_data["url"]
+    assert webhook.headers["X-Custom-Header"] == webhook_data["headers"]["X-Custom-Header"]
+
+
+def test_get_webhook(client):
+    """Test getting a single webhook."""
+    # Create a webhook first
+    webhook_data = {
+        "url": "https://example.com/webhook",
+    }
+
+    created_webhook = client.create_webhook(webhook_data)
+
+    # Get the webhook
+    webhook = client.get_webhook(created_webhook.uuid)
+
+    assert webhook.uuid == created_webhook.uuid
+    assert webhook.url == webhook_data["url"]
+
+
+def test_get_webhook_not_found(client):
+    """Test getting a webhook that doesn't exist."""
+    with pytest.raises(MeilisearchApiError):
+        client.get_webhook("non-existent-uid")
+
+
+def test_update_webhook(client):
+    """Test updating a webhook."""
+    # Create a webhook first
+    webhook_data = {
+        "url": "https://example.com/webhook",
+    }
+
+    created_webhook = client.create_webhook(webhook_data)
+
+    # Update the webhook
+    update_data = {
+        "url": "https://example.com/updated-webhook",
+    }
+
+    updated_webhook = client.update_webhook(created_webhook.uuid, update_data)
+
+    assert updated_webhook.uuid == created_webhook.uuid
+    assert updated_webhook.url == update_data["url"]
+
+
+def test_delete_webhook(client):
+    """Test deleting a webhook."""
+    # Create a webhook first
+    webhook_data = {
+        "url": "https://example.com/webhook",
+    }
+
+    created_webhook = client.create_webhook(webhook_data)
+
+    # Delete the webhook
+    status_code = client.delete_webhook(created_webhook.uuid)
+
+    assert status_code == 204
+
+    # Verify it's deleted
+    with pytest.raises(MeilisearchApiError):
+        client.get_webhook(created_webhook.uuid)
+
+
+def test_delete_webhook_not_found(client):
+    """Test deleting a webhook that doesn't exist."""
+    with pytest.raises(MeilisearchApiError):
+        client.delete_webhook("non-existent-uid")
+
+
+def test_create_webhook_missing_required_fields(client):
+    """Test creating a webhook without required fields."""
+    # Missing 'url' field
+    webhook_data = {
+        "headers": {
+            "Authorization": "Bearer secret-token",
+        },
+    }
+
+    with pytest.raises(MeilisearchApiError):
+        client.create_webhook(webhook_data)

tests/conftest.py

@@ -31,6 +31,21 @@ def clear_indexes(client):
         client.wait_for_task(task.task_uid)
 
 
+@fixture(autouse=True)
+def clear_webhooks(client):
+    """
+    Auto-clears the webhooks after each test function run.
+    Makes all the test functions independent.
+    """
+    # Yields back to the test function.
+
+    yield
+    # Deletes all the webhooks in the Meilisearch instance.
+    webhooks = client.get_webhooks()
+    for webhook in webhooks.results:
+        client.delete_webhook(webhook.uuid)
+
+
 @fixture(autouse=True)
 def clear_all_tasks(client):
     """