Skip to main content

AI Search Actions

Actions from the AI Search add-on. These fire only while it is installed and active. Every other area is listed on the Action Hooks Reference. Each name links to its own page, with its parameters, notes and an example.

Act before and after a search, a production-panel search, and a pinned result being saved or deleted.

Action Description
benecaster_ai_search_before_search Fires when a visitor’s search from the benecaster_ai_search box has passed every check (AI Search on for the show, the visitor signed in when the box is for signed-in visitors…
benecaster_ai_search_after_search Fires after a search from the benecaster_ai_search box, with the results the visitor is about to receive, after benecaster_ai_search_results.
benecaster_ai_search_before_pin_save Fires before a pinned result is created or changed on Show Settings → AI Search (or through POST / PUT benecaster-ai-search/v1/shows/{show_id}/pins), once the request has passed every check.
benecaster_ai_search_after_pin_save Fires after a pinned result was created or changed on Show Settings → AI Search (or through the pins REST routes), only once the write succeeded.
benecaster_ai_search_before_pin_delete Fires before a pinned result is deleted on Show Settings → AI Search (or through DELETE benecaster-ai-search/v1/shows/{show_id}/pins/{id}).
benecaster_ai_search_after_pin_delete Fires after a pinned result was deleted on Show Settings → AI Search (or through the pins REST routes), only once the delete succeeded.
benecaster_ai_search_before_panel_search Fires before a search from the AI Search production panel, the side panel beside every Benecaster admin screen where a podcaster searches their own back catalog, asks the provider.
benecaster_ai_search_after_panel_search Fires after a search from the AI Search production panel, with the results the podcaster is about to receive, after benecaster_ai_search_panel_results.

See Also

Need this built rather than just documented? See our services →