Python SDK

1. Install the SDK

Requires Python 3.10 or newer. The package is named wayo-agent. Use the download until registry publication is complete.

# Extract wayo-agent-python.zip first
python -m pip install ./wayo-agent-python

python -m pip install wayo-agent

2. Set your signing secret

In Settings → Developers, copy your signing secret. It is required by the SDK, for Chat, Webhook and REST alike.

$env:WAYO_SECRET="whsec_REPLACE_WITH_YOUR_REAL_SECRET"

export WAYO_SECRET="whsec_REPLACE_WITH_YOUR_REAL_SECRET"

3. Return your first reply

Start with this complete local example. It returns a connection test reply.

from wayo_agent import Wayo
wayo = Wayo.from_env()
wayo.on_message(lambda message: "Wayo is connected.")

if __name__ == "__main__":
    wayo.serve(port=8080)

python standalone.py

Return plain text or an object containing a nonempty reply. Replace the test reply with your own inventory or business lookup. Register only one handler.

from fastapi import Request
from fastapi.responses import JSONResponse

# Register your wayo.on_message handler first.
@app.post("/wayo")
async def wayo_route(request: Request):
    status, data = await wayo.handle(
        body=await request.body(), headers=request.headers
    )
    return JSONResponse(data, status_code=status)

# In app.py, after registering your answer function:
app = wayo.app()

# Install and run from your terminal:
# python -m pip install uvicorn
# python -m uvicorn app:app --port 8080

4. Connect in Wayo

Deploy behind a public HTTPS address or expose your local server through an HTTPS tunnel. Localhost cannot be used as a Wayo endpoint.

https://your-business.example/

Choose Chat API, enter your final endpoint, and press Test connection. Expect “Wayo is connected.” Then replace the test reply with real data and test again before saving.

The same handler accepts Webhook POST and REST GET. See Requests & replies for their formats. Standalone examples are for development; use your usual production hosting for real traffic.