Search Webhook

What is a search webhook?

Search webhook provides a way for you to adjust the search/recommendation request query as you desire.

What kind of webhook do we have?

Pre-search Hook

This hook is usable for both search and recommendation

This hook allows you to adjust the search/recommendation query before the Original query is executed, Makaira will then execute the adjusted query and evaluate the result.

  • If the request is failed or the search/recommendation result is empty, the original query will be used to execute the request again.
  • If the request is succeeded and the search/recommendation result is not empty, skip the original query and proceed to the next step

Post-search Hook

This hook is usable for both search and recommendation

This hook allows you to adjust the search/recommendation query after the Original query is executed and the result of the Original query is empty

Modify result hook

This hook is usable for recommendation only

This hook allows you to adjust the final result of the recommendation to add or remove some specific products from the recommendation result.

How to create a Search Query Hook?

Please refer to this API docs for more detail: https://docs.makaira.io/reference/post_search-query-hook