📢 Announcing our research paper: Zentry achieves 26% higher accuracy than OpenAI Memory, 91% lower latency, and 90% token savings! Read the paper to learn how we're revolutionizing AI agent memory.

​
Overview

Webhooks enable real-time notifications for memory events in your Zentry project. Webhooks are configured at the project level, meaning each webhook is tied to a specific project and receives events solely from that project. You can configure webhooks to send HTTP POST requests to your specified URLs whenever memories are created, updated, or deleted.

​
Managing Webhooks

​
Create Webhook

Create a webhook for your project; it will receive events only from that project: 
import os
from Zentry import MemoryClient

os.environ["Zentry_API_KEY"] = "your-api-key"

client = MemoryClient()

# Create webhook in a specific project
webhook = client.create_webhook(
    url="https://your-app.com/webhook",
    name="Memory Logger",
    project_id="proj_123",
    event_types=["memory_add"]
)
print(webhook)

​
Get Webhooks

Retrieve all webhooks for your project: 
# Get webhooks for a specific project
webhooks = client.get_webhooks(project_id="proj_123")
print(webhooks)

​
Update Webhook

Update an existing webhook’s configuration by specifying its webhook_id: 
# Update webhook for a specific project
updated_webhook = client.update_webhook(
    name="Updated Logger",
    url="https://your-app.com/new-webhook",
    event_types=["memory_update", "memory_add"],
    webhook_id="wh_123"
)
print(updated_webhook)

​
Delete Webhook

Delete a webhook by providing its webhook_id: 
# Delete webhook from a specific project
response = client.delete_webhook(webhook_id="wh_123")
print(response)

​
Event Types

Zentry supports the following event types for webhooks:
  • memory_add: Triggered when a memory is added.
  • memory_update: Triggered when an existing memory is updated.
  • memory_delete: Triggered when a memory is deleted.

​
Webhook Payload

When a memory event occurs, Zentry sends an HTTP POST request to your webhook URL with the following payload: 
{
    "event_details": {
        "id": "a1b2c3d4-e5f6-4g7h-8i9j-k0l1m2n3o4p5",
            "data": {
            "memory": "Name is Alex"
            },
        "event": "ADD"
    }
}

​
Best Practices

  1. Implement Retry Logic: Ensure your webhook endpoint can handle temporary failures by implementing retry logic.
  2. Verify Webhook Source: Implement security measures to verify that webhook requests originate from Zentry.
  3. Process Events Asynchronously: Process webhook events asynchronously to avoid timeouts and ensure reliable handling.
  4. Monitor Webhook Health: Regularly review your webhook logs to ensure functionality and promptly address any delivery failures.
If you have any questions, please feel free to reach out to us using one of the following methods:

Telegram

Join our community

GitHub

Ask questions on GitHub

Support

Talk to founders