Skip to main content

Overview

These examples show complete integrations from API setup to result retrieval. Copy and adapt them for your use case.

Example 1: Embed Interview Practice on Your Website

Build a page where candidates practice interviews and you get scored results. The AI interviewer pulls each candidate’s real CV from your ATS mid-session via a custom tool so questions reference their actual experience.

Setup

Register a custom tool (one-time)

Register a lookup_candidate tool once on your account so the AI interviewer can pull the candidate’s CV from your ATS during the session. The function runs on your server — Waterr just calls your webhook when the LLM emits the tool call.

Handle the tool call (webhook)

Now when the candidate joins, the AI interviewer’s first turn can be: “Hi Jane — I see you’ve been a senior backend engineer at Acme for three years. I’d love to dig into the payments-platform migration on your CV. Can you walk me through it?”

Frontend

The tool definition is account-scoped — register lookup_candidate once and attach it to every interview scenario you ship. Rotating the webhook secret or updating the JSON Schema propagates to every attached scenario instantly. See the Tools guide for the full CRUD surface.

Example 2: Batch Assessment Pipeline

Run assessments for multiple candidates and collect results in a spreadsheet.

Example 3: Webhook-Driven Analytics Dashboard

Receive results in real-time via webhook and store them in your database.

Webhook receiver (Express)

Register the webhook

Always respond with a 2xx status to webhook requests, even if you encounter an error processing the data. Non-2xx responses trigger retries, which can lead to duplicate processing.