Documentazione

API JavaScript

Metodi globali disponibili dopo il caricamento dello script del widget.

Respondo.init(config)

Inizializza e monta il widget. Deve essere chiamato una sola volta. Restituisce l’istanza del widget.

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

Respondo.identify(identity)

Associa l’identità dell’utente alla sessione corrente. Chiamalo dopo l’accesso. Con un’email o uno userId crea subito il contatto, anche se l’utente non apre mai la chat. signedUpAt (un Date, secondi Unix o una stringa ISO 8601) indica quando l’utente si è registrato nel tuo prodotto; senza, la data di registrazione del contatto resta vuota.

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  signedUpAt: '2024-05-31T10:00:00Z',
  userHash: 'hmac_sha256_signature', // facoltativo, per la verifica dell'identità
  metadata: { plan: 'pro' },
  properties: {                      // proprietà di contatto personalizzate
    account_type: 'enterprise',      // chiavi definite in Agent Settings
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)

Registra un evento lato client per il visitatore corrente (es. acquisto, upgrade del piano). Gli eventi possono avviare Tour attivati da eventi e contare per gli obiettivi dei tour. Consegna best-effort con keepalive, quindi gli eventi emessi subito prima di una navigazione (redirect al checkout) arrivano comunque. Chiamalo dopo init().

Gli eventi aprono anche i sondaggi pop-up che li attendono (When and where): subito su una pagina corrispondente, oppure all’arrivo su una di esse entro 30 minuti, ad esempio dopo un reindirizzamento.

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

Respondo.startSurvey(surveyId)

Apre subito un sondaggio pop-up attivo, su qualsiasi pagina, ignorando Show on, le regole di pagina, il tempo sulla pagina, l’evento di attivazione e il pubblico. Copia l’id dall’editor del sondaggio (Additional ways to share). Un sondaggio a cui il visitatore ha già risposto non viene mostrato di nuovo. Si può chiamare prima che il widget abbia finito di caricarsi.

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

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

Apre o chiude il messenger dai tuoi pulsanti. Passa una stringa a open per partire con il campo del messaggio già compilato. Chiamalo dopo Respondo.init(); una chiamata fatta mentre il launcher sta ancora comparendo viene applicata appena compare.

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

Respondo.destroy()

Rimuove il widget dalla pagina. Utile per le SPA quando si naviga verso pagine in cui il widget non deve apparire. Non cancella l’identità del visitatore né la conversazione memorizzata — per il logout usa Respondo.reset().

// Rimuovi il widget dalla pagina
Respondo.destroy();

// Reinizializza più tardi se necessario (riprende la stessa conversazione)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()

Logout / passaggio su dispositivo condiviso. Cancella dal browser il visitor id anonimo, la conversazione memorizzata e il token di sessione, revoca il token di sessione lato server così le sue copie smettono di funzionare, e rimonta un widget anonimo nuovo. Chiamalo dall’hook di logout della tua app.

// Al logout — cancella identità, conversazione e sessione, riparti da zero
Respondo.reset();

Raccolta automatica dei dati

Il widget acquisisce e memorizza automaticamente quanto segue con ogni conversazione:

DatoOrigine
IP del clientHeader HTTP
Browser / OSHeader User-Agent
LinguaHeader Accept-Language
Fuso orarioIntl API (JavaScript)
URL della paginawindow.location
ReferrerHeader Referer