REST API

Use an existing search or information API. Wayo puts the customer’s question in a URL parameter.

Before you start

1
Check the query parameter
Your API must accept the question as q. If it uses another parameter name, choose Custom HTTP and set that name there.
2
Enter the base endpoint
Choose REST API and enter the search address. Add any credentials your service requires; Wayo supplies the customer’s question.
3
Test the response
Wayo looks for common answer fields in the JSON, or uses the JSON itself. Confirm the result is helpful, add your offerings and reach, then connect.

Example request · GET

https://your-api.example/search?q=Do%20you%20deliver%20to%20Austin%3F

Example JSON response

{
  "answer": "We deliver within 25 km of Austin."
}

Example addresses and IDs are placeholders. Replace them with your service’s values.

These examples connect an API directly. Using the SDK? See SDK return formats and when a signing secret is required.

The test can read the JSON response and show useful information from your service.

Getting your page ready…

Connect step by step

Your API must accept the question as q. If it uses another parameter name, choose Custom HTTP and set that name there.

Choose REST API and enter the search address. Add any credentials your service requires; Wayo supplies the customer’s question.

Wayo looks for common answer fields in the JSON, or uses the JSON itself. Confirm the result is helpful, add your offerings and reach, then connect.

Request & response

Example request · GET

https://your-api.example/search?q=Do%20you%20deliver%20to%20Austin%3F

Example JSON response

{
  "answer": "We deliver within 25 km of Austin."
}

Example addresses and IDs are placeholders. Replace them with your service’s values.