Skip to main content

Webhook Events

List of all available events.

search.completed​

Triggered when a user performs a search.

{
  "id": "evt_123",
  "type": "search.completed",
  "created": "2024-01-15T10:30:00Z",
  "data": {
    "searchLogId": "log_abc123",
    "query": "running shoes",
    "resultsCount": 25,
    "queryTimeMs": 45,
    "filters": {
      "categories": ["sports"],
      "priceMax": 150
    }
  }
}

search.zero_results​

When a search returns no results.

{
  "id": "evt_124",
  "type": "search.zero_results",
  "created": "2024-01-15T10:31:00Z",
  "data": {
    "searchLogId": "log_abc124",
    "query": "nonexistent product",
    "suggestedQueries": ["similar product", "alternative"]
  }
}

Products​

product.clicked​

When a user clicks on a search result.

{
  "id": "evt_125",
  "type": "product.clicked",
  "created": "2024-01-15T10:32:00Z",
  "data": {
    "searchLogId": "log_abc123",
    "productId": "prod_456",
    "position": 3,
    "query": "running shoes"
  }
}

product.synced​

When a product is synced.

{
  "id": "evt_126",
  "type": "product.synced",
  "created": "2024-01-15T10:33:00Z",
  "data": {
    "productId": "prod_456",
    "externalId": "SKU-001",
    "action": "created" // created | updated | deleted
  }
}

Subscription​

subscription.created​

New active subscription.

{
  "id": "evt_127",
  "type": "subscription.created",
  "created": "2024-01-15T10:34:00Z",
  "data": {
    "subscriptionId": "sub_789",
    "plan": "GROWTH",
    "billingCycle": "MONTHLY"
  }
}

subscription.cancelled​

Subscription cancelled.

{
  "id": "evt_128",
  "type": "subscription.cancelled",
  "created": "2024-01-15T10:35:00Z",
  "data": {
    "subscriptionId": "sub_789",
    "reason": "user_requested",
    "effectiveDate": "2024-02-15T00:00:00Z"
  }
}

Usage​

usage.limit_approaching​

When usage approaches the limit (80%).

{
  "id": "evt_129",
  "type": "usage.limit_approaching",
  "created": "2024-01-15T10:36:00Z",
  "data": {
    "metric": "searches",
    "current": 4000,
    "limit": 5000,
    "percentage": 80
  }
}

usage.limit_exceeded​

When the limit is exceeded.

{
  "id": "evt_130",
  "type": "usage.limit_exceeded",
  "created": "2024-01-15T10:37:00Z",
  "data": {
    "metric": "searches",
    "current": 5100,
    "limit": 5000,
    "overage": 100
  }
}

Filter events​

You can subscribe to specific events only in the Dashboard.

CategoryEvents
Searchsearch.completed, search.zero_results
Productsproduct.clicked, product.synced
Subscriptionsubscription.created, subscription.cancelled
Usageusage.limit_approaching, usage.limit_exceeded