Skip to content

Channels: Webhook

Webhook is a Tier 1 integration channel. It is the general-purpose route for systems that do not have a dedicated channel. Wayland exposes an inbound URL for messages coming in, and posts replies to an outbound URL you provide.

Before you start (prerequisites and accounts)

Section titled “Before you start (prerequisites and accounts)”
  • A system that can send HTTP requests and receive them at a URL you control.
  • The Wayland desktop app running with a model provider connected.

Create the credentials (on the provider side)

Section titled “Create the credentials (on the provider side)”

Decide where replies should go and prepare an HTTPS endpoint in your system to receive them. Choose a shared secret so each side can verify the other.

Connect it in Wayland (Settings -> Channels -> Webhook)

Section titled “Connect it in Wayland (Settings -> Channels -> Webhook)”
  1. Open Settings -> Channels and choose Webhook.
  2. Enter the Outbound URL where Wayland should post replies.
  3. Enter the Outbound secret used to sign or authenticate outbound requests.
  4. Save.
  5. Copy the inbound Webhook URL shown on the page and configure your system to send messages there.

Verify (status goes from idle to connected, send a test message)

Section titled “Verify (status goes from idle to connected, send a test message)”

After saving, the status moves from idle to connected. Send a request to the inbound URL and confirm Wayland posts a reply to your outbound URL.

Set the assistant and default model on the Webhook page. Inbound payloads route to that assistant.

If replies do not arrive at your endpoint, confirm the outbound URL and secret, and that your endpoint returns a success status. See Channel Connection Issues.