What are Webhooks?

Webhooks are a way for Thieves to send real-time notifications to other applications when your monitoring conditions are met. Think of them as automated messages that Thieves sends to a URL you provide. Instead of your application constantly asking Thieves, "Has anything changed?", Thieves proactively tells your application, "Yes, something just happened!"

Webhook Output Format

When a condition is met, Thieves sends a POST request to your specified webhook URL with a JSON payload. The payload contains the following information:

{
    "tracker_id": "int",
    "tracker_name": "string",
    "checked_at": "datetime",
    "condition": "string",
    "running": "Boolean",
    "result": "Boolean",
    "check_frequency":  "integer",
    "url": "string",
    "description": "string",
}
                

• tracker_id: The ID of the tracker
• tracker_name: The name of the tracker
• checked_at: The timestamp when the check was performed (datetime object, UTC).
• condition: The condition being checked.
• running: A boolean value (true or false) indicating whether the tracker is running or not.
• result: A boolean value (true or false) indicating the result of the check.
• check_frequency: How often the check is performed in seconds.
• url: The URL of the tracked website.
• description: How the LLM made its decision on determining if the condition is met or not.

Example

{
    "tracker_id": 125,
    "tracker_name": "Pear Price",
    "checked_at": 2025-03-02T01:50:34.093370+00:00,
    "condition": "the price of pears drops below $50",
    "running": false,
    "result": true,
    "check_frequency": 86400,
    "url": "https://example.com/product/123",
    "description": "The price per pear is $40 which is below the user's condition of $50",
}