Whatsplaid
Taal en valuta
Gratis beginnen
Plannen
Zoeken op de site
Taal en valuta
Publieke API en documentatie

Koppel uw systemen aan Whatsplaid met API's, connectors en webhooks.

Gebruik de publieke API om contacten, gesprekken, berichten, menselijke ondersteuning en de AI-agent te integreren. Gebruik de externe connector om gegevens uit uw systeem op te vragen en webhooks om real-time gebeurtenissen te ontvangen.

Drie contracten

Kies de juiste richting van de integratie.

De Swagger-documentatie scheidt de stromen om verwarring te voorkomen tussen oproepen naar Whatsplaid, query's die door de assistent worden gedaan en gebeurtenissen die naar uw systeem worden verzonden.

01 Public API

Uw systeem roept Whatsplaid aan om mogelijkheden op te vragen, contacten te beheren, gesprekken te volgen, berichten te verzenden, de AI-agent te bedienen en menselijke ondersteuning aan te vragen.

02 Custom Data Connector

Whatsplaid roept uw systeem aan om tijdens een gesprek producten, bestellingen, klanten of realtime beschikbaarheid op te vragen.

Ontdek de externe connector via API
03 Outgoing Webhooks

Whatsplaid stuurt lead‑gebeurtenissen, berichten, bezorgstatussen, tickets en wijzigingen van de AI-agent naar een geconfigureerde URL.

04 Documentatie

De Swagger op `api.whatsplaid.com/docs/` bevat de schema's, voorbeelden, verwachte reacties en volledige technische contracten.

Snelreferentie voor de belangrijkste endpoints.

Deze weergave vat de functies samen die in de officiële documentatie voorkomen. De uiteindelijke implementatie moet voldoen aan Swagger.

GET /store

Geeft accountgegevens, verbonden e-commerce en actieve modules terug.

Account
GET /capabilities

Geeft aan welke bewerkingen daadwerkelijk beschikbaar zijn op basis van account, abonnement, modules en integraties.

Account
GET /ecommerce/products/search

Zoek naar producten in verbonden native integraties, zoals Nuvemshop, Wix of Shopify.

Ecommerce
GET /ecommerce/orders/search

Zoek bestellingen op nummer, e-mail of telefoon in de verbonden native integraties.

Ecommerce
POST /contacts

Maakt of werkt een contact bij met het telefoonnummer als primaire sleutel.

Contacts
GET /conversations

Lijst met gesprekken gestart door contactpersonen, met paginering, antwoordvenster en status van de AI-agent.

Conversations
GET /conversations/{conversationId}/messages

Geeft de gepagineerde berichtgeschiedenis van een gesprek terug.

Conversations
PATCH /contacts/{contactId}/custom-fields

Werk aangepaste velden bij voor targeting en operationele context.

Fields
POST /messages/send

Verstuurt een sms-bericht binnen het 24-uurs berichtvenster van WhatsApp.

Messaging
POST /handoffs

Vraag menselijke ondersteuning aan met de huidige configuratie van het bedrijf.

Handoff
GET /tickets

Lijst met menselijke supporttickets met filters en paginering.

Tickets
POST /tickets/{ticketId}/close

Sluit het ticket, genereert het bijbehorende evenement en activeert de AI-agent van het gesprek opnieuw.

Tickets
PATCH /conversations/{conversationId}/ai-agent

Activeer of pauzeer de AI-agent alleen voor het opgegeven gesprek.

Conversations
GET /ai-agent/prompt

Controleert de bewerkbare prompt die als basisinstructie van de AI-agent wordt gebruikt.

AI Agent
PATCH /ai-agent/prompt

Werk de bewerkbare prompt bij met revisiebeheer om gelijktijdige overschrijvingen te voorkomen.

AI Agent
Technische contracten

De documentatie behandelt de API, de externe connector en webhooks.

Contracten scheiden oproepen naar Whatsplaid, queries die de agent in externe systemen uitvoert, en events die door Whatsplaid worden verzonden.

Openbare API

Controleert account en mogelijkheden, beheert contacten, tags en aangepaste velden, volgt gesprekken en verzendt berichten binnen het toegestane venster.

AI-agent

Bekijk en werk de bewerkbare prompt bij, en schakel de agent in elk gesprek afzonderlijk in of pauzeer deze.

Gesprekken en berichten

Toegang tot chatgeschiedenis, paginering, WhatsApp-antwoordvenster en de huidige status van de AI-agent.

Externe connector

Uw systeem kan product-, order-, klant- en beschikbaarheidsquery's blootstellen voor gebruik door de agent tijdens het gesprek.

Webhooks

Beschikbare events: `lead.created`, `message.received`, `message.sent`, `message.status.updated`, `ticket.created`, `ticket.closed` en `conversation.ai_agent.updated`.

Betrouwbare levering

Webhooks gebruiken `delivery_id` voor deduplicatie en nieuwe pogingen bij tijdelijke fouten. De bezorging wordt pas als voltooid beschouwd na een HTTP 2xx-respons.

Moet u een integratie implementeren of valideren?

Open de interactieve documentatie om te schakelen tussen `Whatsplaid Public API`, `Custom Data Connector Contract` en `Outgoing Webhooks`.

Open Swagger