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.
- Your frontend sends the customer's message to your server.
- Your server calls Send a message and stores the
session_idit gets back for that customer. - Send the stored
session_idwith every following message so the AI remembers the conversation. - When
ask_emailistrue, show an email field; send the address incustomer.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.
- On a schedule, call List leads, for example with
rank=hotandsort=recent. - Use
offsetandhas_moreto page through the results. - Use
lead_idto avoid creating the same lead twice in your CRM. - 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.
- Call List conversations with
status=unresolved. - Read the details with Get messages: AI replies that couldn't answer have
answer_typeNO_ANSWER. - Add the missing answer with Add an FAQ. New content is trained automatically.
Share meetings with your team's tools
- Call List meetings with
start_dateandend_date, for example for today's agenda. scheduled_dateandscheduled_timeare in the host's time zone, given inscheduled_timezone.- 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.
- Upload new or changed documents with Upload a document.
- Add or update FAQs with Add an FAQ and Update an FAQ.
- Check progress with List knowledge:
isTrainedshows whether the AI has learned an item yet.
Training is billed. See Usage limits and billing.