Documentatie

JavaScript API

Globale methoden die beschikbaar zijn na het laden van het widget-script.

Respondo.init(config)

Initialiseert en plaatst de widget. Moet één keer worden aangeroepen. Retourneert de widget-instantie.

const widget = Respondo.init({
  agentId: 'YOUR_AGENT_ID'
});

Respondo.identify(identity)

Koppelt de gebruikersidentiteit aan de huidige sessie. Roep dit aan na het inloggen. Met een e-mailadres of userId wordt het contact meteen aangemaakt, ook als de gebruiker de chat nooit opent. signedUpAt (een Date, Unix-seconden of een ISO 8601-string) is wanneer de gebruiker zich in je product heeft geregistreerd; zonder blijft de registratiedatum van het contact leeg.

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  signedUpAt: '2024-05-31T10:00:00Z',
  userHash: 'hmac_sha256_signature', // optioneel, voor identiteitsverificatie
  metadata: { plan: 'pro' },
  properties: {                      // aangepaste contacteigenschappen
    account_type: 'enterprise',      // sleutels gedefinieerd in Agent Settings
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)

Registreert een client-side event voor de huidige bezoeker (bijv. aankoop, planupgrade). Events kunnen event-getriggerde Tours starten en meetellen voor tourdoelen. Best-effort bezorging met keepalive, zodat events die vlak vóór een navigatie worden verstuurd (checkout-redirect) toch aankomen. Aanroepen ná init().

Events openen ook pop-up-enquêtes die erop wachten (When and where): meteen op een passende pagina, of bij aankomst op zo’n pagina binnen 30 minuten, bijvoorbeeld na een redirect.

Respondo.track('purchase_completed', {
  plan: 'pro',
  amount: 49
});

Respondo.startSurvey(surveyId)

Opent nu een actieve pop-up-enquête, op elke pagina, zonder rekening te houden met Show on, paginaregels, tijd op de pagina, het trigger-event en de doelgroep. Kopieer het id in de enquête-editor (Additional ways to share). Een enquête die de bezoeker al heeft beantwoord, wordt niet opnieuw getoond. Kan worden aangeroepen voordat de widget klaar is met laden.

Respondo.startSurvey('<survey-id>');

Respondo.open(message?) / Respondo.close()

Opent of sluit de messenger vanuit je eigen knoppen. Geef een string mee aan open om te beginnen met een vooraf ingevuld berichtveld. Aanroepen ná Respondo.init(); een aanroep terwijl de launcher nog verschijnt, wordt toegepast zodra die er is.

Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();

Respondo.destroy()

Verwijdert de widget van de pagina. Handig voor SPA’s wanneer je navigeert naar pagina’s waar de widget niet mag verschijnen. Het wist de identiteit of het opgeslagen gesprek van de bezoeker niet — gebruik voor uitloggen Respondo.reset().

// Verwijder de widget van de pagina
Respondo.destroy();

// Herinitialiseer later indien nodig (hervat hetzelfde gesprek)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()

Uitloggen / overdracht op een gedeeld apparaat. Wist de anonieme bezoekers-id, het opgeslagen gesprek en het sessietoken uit de browser, trekt het sessietoken aan de serverzijde in zodat kopieën ervan niet meer werken, en plaatst een verse anonieme widget opnieuw. Roep dit aan vanuit de uitlog-hook van je app.

// Bij uitloggen — wis identiteit, gesprek en sessie, begin opnieuw
Respondo.reset();

Automatische gegevensverzameling

De widget legt automatisch het volgende vast en slaat dit op bij elk gesprek:

GegevensBron
Client-IPHTTP-headers
Browser / OSUser-Agent-header
TaalAccept-Language-header
TijdzoneIntl API (JavaScript)
Pagina-URLwindow.location
ReferrerReferer-header