Guides and resources

Integration scenarios

These scenarios show which endpoints to combine for common integrations. Each one works with the NUWAY API, and most can also be built in n8n without code.

Answer chats in your own app

Show NUWAY's AI workers inside your app, support tool or custom website chat.

  1. Your frontend sends the customer's message to your server.
  2. Your server calls Send a message and stores the session_id it gets back for that customer.
  3. Send the stored session_id with every following message so the AI remembers the conversation.
  4. When ask_email is true, show an email field; send the address in customer.email.

A complete example: Server-side chat relay.

Meetings booked in chat

When a customer books a meeting, NUWAY emails them a verification code. Make sure your chat interface lets the customer send that code as their next message. See Booking meetings through chat.

Send leads to your CRM

Copy the leads NUWAY scores into your CRM or database.

  1. On a schedule, call List leads, for example with rank=hot and sort=recent.
  2. Use offset and has_more to page through the results.
  3. Use lead_id to avoid creating the same lead twice in your CRM.
  4. For the full history of one lead, call Get a lead.

In n8n: a Schedule Trigger, the NUWAY node's Lead → Get Many, then your CRM's node. See n8n.

Follow up on unanswered questions

Find conversations where the AI couldn't answer, so your team can follow up and teach the AI.

  1. Call List conversations with status=unresolved.
  2. Read the details with Get messages: AI replies that couldn't answer have answer_type NO_ANSWER.
  3. Add the missing answer with Add an FAQ. New content is trained automatically.

Share meetings with your team's tools

  1. Call List meetings with start_date and end_date, for example for today's agenda.
  2. scheduled_date and scheduled_time are in the host's time zone, given in scheduled_timezone.
  3. To cancel a meeting, call Cancel a meeting with an optional reason.

To reschedule, cancel the meeting and book a new one through chat.

Keep training data in sync

Keep what your AI workers know in step with your own documents and FAQs.

  1. Upload new or changed documents with Upload a document.
  2. Add or update FAQs with Add an FAQ and Update an FAQ.
  3. Check progress with List knowledge: isTrained shows whether the AI has learned an item yet.

Training is billed. See Usage limits and billing.