Whatsplaid
Plannen
Zoeken op de site
Openbare API en documentatie

Verbind je eigen systemen met Whatsplaid via API, connectors en webhooks.

Gebruik de openbare API wanneer een ander systeem Whatsplaid moet activeren. Gebruik de externe connector wanneer de assistent producten, bestellingen of gegevens uit je systeem moet opvragen tijdens het gesprek. Gebruik webhooks om gebeurtenissen te ontvangen die in WhatsApp worden vastgelegd.

Drie contracten

Kies de juiste richting van de integratie.

De Swagger-documentatie scheidt de stroom om verwarring tussen oproepen naar Whatsplaid, vragen van de assistent en gebeurtenissen die naar je systeem worden gestuurd te voorkomen.

01 Public API

Je systeem roept Whatsplaid aan om accounts te verifiëren, contacten, tags, velden, gesprekken, winkelwagen, berichten en menselijke ondersteuning te beheren.

02 Custom Data Connector

Whatsplaid roept je systeem aan om producten, bestellingen, klanten of beschikbaarheid in realtime te controleren tijdens een gesprek.

03 Outgoing Webhooks

Whatsplaid stuurt gebeurtenissen naar een door jou opgegeven URL. De gebeurtenis die in het dashboard wordt weergegeven, is de lead die tijdens het gesprek is vastgelegd.

04 Documentatie

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

Snelle referentie van de belangrijkste endpoints.

Dit overzicht geeft een samenvatting van de functies die in de officiële documentatie worden vermeld. De uiteindelijke implementatie moet de Swagger volgen.

GET /store

Geeft gegevens terug over het account, verbonden e-commerce en actieve modules.

Account
GET /modules

Lijst met actieve modules, zoals leads, verkoopadviseur, post-verkoop, kennisbank en winkelwagen.

Account
GET /ecommerce/products/search

Zoek producten in de 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

Maak of werk contact bij met gebruik van telefoon als hoofd sleutel.

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

Werk aangepaste velden bij voor segmentatie en operationele context.

Fields
POST /messages/send

Verzend sms-bericht binnen het 24-uurs servicevenster van WhatsApp.

Messaging
POST /handoffs

Vraag menselijke ondersteuning aan met de huidige bedrijfsinstelling.

Handoff
Technische contracten

De documentatie behandelt API, externe connector en webhooks.

Het integratiemenu van ADMIN gebruikt dezelfde scheiding: openbare API van Whatsplaid, externe connector voor query's in eigen systemen en uitgaande webhook voor vastgelegde leads.

API pública

Valideer account, modules, contacten, tags, aangepaste velden, berichten, gesprekken, winkelwagen en menselijke ondersteuning.

Externe connector

Je systeem exposeert endpoints zoals `/products/search` en `/orders/search` voor Whatsplaid om tijdens het gesprek te raadplegen.

Producten

Verwacht antwoord met `products`, inclusief ID, naam, beschrijving, prijs, beschikbaarheid, voorraad, URL en afbeelding.

Bestellingen

Verwacht antwoord met `orders`, inclusief nummer, status, betaling, levering, totaal, klant, tracking en items.

Webhooks

Het `LEAD_CAPTURE`-evenement verzendt leadgegevens naar de geconfigureerde URL. De endpoint moet HTTP 200 of 204 antwoorden.

Beveiliging

Gebruik `Authorization: Bearer` in de oproepen. Tokens mogen niet worden blootgesteld aan de openbare frontend.

Moet je een integratie implementeren of valideren?

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

Swagger openen