This content has been translated from Japanese using LLM. There may be some awkward nuances in the translation.

How to Use WebHooks

What is a WebHook?

The WebHook feature allows you to automatically send search data to a custom endpoint when performing searches.

Setup Instructions

1. Setting the Base URL

Enter the Base URL in the settings screen.

Example:

code
https://your-api.com

2. Setting the Bearer Token

Configure the Bearer Token for authentication.

Example:

code
your-bearer-token-here

How It Works

When a search is executed, data is sent through the following mechanism:

Destination URL

code
{Base URL}/query

Note: Currently only the

code
/query
endpoint is supported, but support for various endpoints is planned for the future.

Transmission Method

  • HTTP Method: POST
  • Authentication: Bearer Token (included in Authorization header)

Data Format

json
{ "query": "search query", "tag": "tag name" }

Possible Applications

Integration with External Services

  • Notion: Automatically save search results to Notion database
  • Slack: Notify search queries to Slack channels
  • Discord: Post search history to Discord servers
  • Zapier: Automatic integration with other services

Integration with AI Agents

  • External AI Agents: Send search data to AI agents for automatic processing
  • Custom AI: Integration with your own AI systems
  • Workflow Automation: Automatic task execution based on search results

Data Analysis & Storage

  • Search Log Storage: Store search history in external databases
  • User Behavior Analysis: Analyze search patterns
  • Report Generation: Automatic report creation based on search data

Usage Example

Base URL:

code
https://api.example.com

Bearer Token:
code
abc123def456

Search Query: "Latest AI Technology"
Tag: "technology"

Destination:

code
https://api.example.com/query

Authorization Header:
code
Bearer abc123def456

Data Sent:

json
{ "query": "Latest AI Technology", "tag": "technology" }

Summary

The WebHook feature enables automatic transmission of search data to external systems.

Configuration Items:

  • Base URL (destination base URL)
  • Bearer Token (authentication token)

Transmission Timing: During search execution
Destination:

code
{Base URL}/query
Authentication: Sent in Authorization header as
code
Bearer {token}

Data Sent: Query and tag information
Future Support: Planning to support various endpoints

Comprehension Check