Skip to main content

Nuova integrazione

Come creare un'integrazione con vtenext in Zapier

1. Come prima cosa è necessario andare su https://developer.zapier.com/ effettuare l'accesso con le proprie credenziali Zapier, e cliccare su "Start a Zapier Integration"

image-1688997649695.png

2. E' poi necessario compilare tutti i campi che la schermata di Zapier ci chiede.

Esempio:

Name: vtenext
Description: Integra vtenext con Zapier
Audience: Private
Role: I have no affiliation with...
Category: CRM

image-1688998674505.png

3. Dopo un messaggio di salvataggio eseguito e creazione avvenuta con successo, sarà possibile configurare il tipo di Autenticazione

image-1688998892622.png

Dovrà essere selezionato BASIC AUTH e conseguentemente clicchiamo su SAVE

image-1688998997284.png

STEP 1: lasciare vuoto e cliccare su CONTINUE

image-1688999648720.png

STEP 2: inserire nel test, il metodo post e configurare l'url la seguente stringa https://VTE-URL/restapi/v1/vtews/listtypes (dove VTE-URL è l'indirizzo assoluto della vostra installazione vtenext)

image-1689002049644.png

STEP 3: è giunto il momento di testare l'autenticazione, cliccando sul bottone azzurro "Sign In" e cliccando infine su SAVE & FINISH.

ATTENZIONE: la password da usare è l'accesskey dell'utente vtenext, che trovate nelle preferenze dell'utente stesso.

image-1689003982494.png

4. Creazione di un trigger

Questo passaggio è opzionale, è necessario solamente se si vogliono scatenare azioni lato Zapier quando in vtenext si verifica una qualche condizione (ad esempio alla creazione di un Lead o da qualsiasi altra condizione scatenata da un processo).

Aggiungiamo quindi un trigger come segue:

image-1691677394684.png

Cliccando sul pulsante CREATE A TRIGGER, verrà presentata una schermata con alcuni campi da compilare. Tali campi andranno gestiti in base a ciò che si vuole ottenere dal trigger stesso (nell'esempio si tratta di intercettare la creazione di un nuovo Lead).

image-1691677670950.png

Una volta compilati tutti i campi, cliccare su SAVE & CONTINUE in fondo alla pagina sulla destra.
Subito dopo comparirà la seguente pagina, dove sarà necessario cliccare su API CONFIGURATION per creare un web hook.

image-1691677894652.png

Allo STEP 1 vanno scelti i seguenti parametri:

SUBSCRIBE

  • REST Hook (è sufficiente selezionarlo)
  • POST (si seleziona dal menu a tendina la voce POST e poi si scrive il web hook seguente, sostituendo VTE-URL con il corretto indirizzo del proprio crm)

image-1691680316892.png

https://VTE-URL/restapi/v1/vtews/zapier.subscribe
{"module":"Leads","hookUrl":"{{bundle.targetUrl}}","zapid":"{{bundle.meta.zap.id}}"}

In questo codice, è possibile sostituire Leads con il modulo che si desidera configurare.

Continuando la configurazione, scrollando in basso la pagina, troviamo l'opzione UNSUBSCRIBE, che dovrà essere configurata col seguente codice

image-1691680531292.png

https://labs2.vtecrm.net:8443/restapi/v1/vtews/zapier.unsubscribe
{{bundle.subscribeData.id}}

Continuando sul parametro PERFORM LIST, si dovrà configurare il seguente codice

image-1691681473958.png

https://VTE-URL/restapi/v1/vtews/zapier.perform_list
Leads

Infine su PAGINATION non c'è nulla da configurare e si clicca su SAVE API Request & Continue.

image-1691681817484.png

Allo STEP 2 della configurazione del Trigger, non va configurato nulla.

image-1691682003664.png

Allo STEP 3 della configurazione del Trigger, è necessario lasciare vuoto il campo presente in quel blocco.

image-1691682110724.png

5. Creazione di azioni

Anche in questo caso, questo passaggio è opzionale, serve solamente se si vogliono scatenare azioni lato vtenext quando Zapier verifica le condizioni impostate. Le azioni eseguibili in vtenext sono: ricerca di un record, creazione, modifica o cancellazione.

E' possibile inoltre creare solamente le azioni necessarie alla propria integrazione.

I. Azione Ricerca

Sulla colonna di sinistra, va cliccata la voce ACTIONS e subito dopo sul bottone ADD ACTION presente invece sulla destra.

image-1691682308455.png

Si aprirà la seguente schermata che andrà compilata come mostrato

image-1706195800205.png

Finito di compilare i campi come mostrato nella precedente immagine, sarà possibile cliccare su SAVE AND CONTINUE. In questo modo si potrà passare alla TAB successiva per configurare l'INPUT DESIGNER.

image-1691760259231.png

In questa schermata, si dovrà cliccare su ADD e scegliere INPUT FIELD e comparirà la schermata di configurazione successiva

image-1691760482484.png

Inserire le variabili indicate negli appositi campi e cliccare dunque sul pulsante SAVE e si passa alla TAB di API CONFIGURATION

image-1691761672586.png

In questa schermata dovranno essere inserite le variabili come mostrato, chiaramente al posto di VTE-URL andrà inserito l'indirizzo completo della vostra installazione vtenext. Infine cliccare su SAVE API REQUEST & CONTINUE.

https://VTE-URL/restapi/v1/vtews/zapier.search
SELECT id FROM Leads WHERE email='{{bundle.inputData.email}}';

Nello STEP 2, fase TEST di questa pagina, andrà inserito un indirizzo email per effettuare alcuni test di connessione (l'indirizzo dovrà essere valido ed esistente).

Alla TAB OUTPUT invece, è necessario:

  1. utilizzare la risposta dai dati del test
  2. generare definizioni dei campi di output
  3. impostare il tipo appropriato per i campi

Infine cliccare su SAVE OUTPUT & FINISH in basso a destra.

II. Azione Crea

Cliccare sempre ADD ACTION per creare una nuova azione e compilare la prima schermata come segue:

Screenshot_20240411_145655.png

Cliccare SAVE AND CONTINUE e passare alla TAB successiva per configurare l'INPUT DESIGNER, in cui va aggiunto un nuovo INPUT FIELD configurato come segue:

2024-04-11-15-36-developer.zapier.com.png

Cliccare su SAVE e passare al tab API Configuration e configurare i parametri nello STEP 1 nel seguente modo:

Screenshot_20240411_154825.png

https://VTE-URL/restapi/v1/vtews/zapier.create

module = Leads
data = {{bundle.inputData.dataField}}

Ovviamente VTE-URL va sostituito con l'indirizzo completo della vostra installazione vtenext, mentre il termine "Leads" può essere sostituito con un altro modulo, se si desidera creare una entità diversa in vtenext (ad esempio Contacts o Accounts). Infine cliccare su SAVE API REQUEST & CONTINUE.

Nello STEP 2, per effettuare un test di creazione lead scegliere "Raw" e sostituire il codice presente con il seguente:

{
  "inputData": {
    "dataField": {
      "firstname":"Test lead",
      "lastname":"Zapier",
      "phone":"123456789",
      "company":"Test Company Zapier"
    }
  },
  "authData": {},
  "environment": {},
  "subscribeData": {},
  "cleanedRequest": {
    "url": "https://example.com/hook-request-origin",
    "method": "POST",
    "body": {},
    "headers": {
      "Content-Type": "application/json"
    }
  }
}

e cliccare su Test Your Request, che dovrebbe dare esito positivo e un Lead con nome "Test Lead" e cognome "Zapier" dovrebbe essersi creato nella vostra installazione vtenext. Cliccare Finish Testing & Continue.

Nello STEP 3 cliccare su Use Response from Test Data e poi Generate Output Field Definitions per mappare automaticamente i campi restituiti. Cliccare infine su Save Output & Finish.

III. Azione Aggiorna

Cliccare sempre ADD ACTION per creare una nuova azione e compilare la prima schermata come segue:

Screenshot_20240411_155651.png

Nella schermata di INPUT DESIGNER creare 2 campi di tipo Input Field, con le seguenti caratteristiche:

  1. Key = id, Label = ID, Type = String, Required = yes
  2. Key = dataField, Label = dataField, Type = Dictionary, Required = no

Una volta creati avremo quindi i seguenti campi:

Screenshot_20240411_155841.png

Passare quindi al tab API Configuration e configurare i parametri nello STEP 1 nel seguente modo:

Screenshot_20240411_160149.png

https://VTE-URL/restapi/v1/vtews/zapier.update

id = {{bundle.inputData.id}}
data = {{bundle.inputData.dataField}}

Sostituendo VTE-URL con l'indirizzo completo della vostra installazione vtenext. Infine cliccare su SAVE API REQUEST & CONTINUE.

Nello STEP 2, per effettuare un test di modifica lead scegliere "Raw" e sostituire il codice presente con il seguente:

{
  "inputData": {
    "id": "2x53",
    "dataField": {
      "phone":"556677"
    }
  },
  "authData": {},
  "environment": {},
  "subscribeData": {},
  "cleanedRequest": {
    "url": "https://example.com/hook-request-origin",
    "method": "POST",
    "body": {},
    "headers": {
      "Content-Type": "application/json"
    }
  }
}

e sostituendo il "53" a riga 3 con l'ID di un lead presente in vtenext:

Screenshot_20240411_160633.png

Screenshot_20240411_160758.png

Cliccando su Test Your Request dovreste ottenere un risultato come il seguente:

Screenshot_20240411_161033.png

Infine nello STEP 3 cliccare sempre su Use Response from Test Data e poi Generate Output Field Definitions per mappare automaticamente i campi restituiti. Cliccare infine su Save Output & Finish.

IV. Azione Elimina

Cliccare sempre ADD ACTION per creare una nuova azione e compilare la prima schermata come segue:

Screenshot_20240411_162620.png

Nella schermata di INPUT DESIGNER creare un campo di tipo Input Field, con le seguenti caratteristiche:

2024-04-11-16-27-developer.zapier.com.png

Passare quindi al tab API Configuration e configurare i parametri nello STEP 1 nel seguente modo:

Screenshot_20240411_162822.png

https://VTE-URL/restapi/v1/vtews/zapier.delete

id = {{bundle.inputData.id}}

Sostituendo VTE-URL con l'indirizzo completo della vostra installazione vtenext. Infine cliccare su SAVE API REQUEST & CONTINUE.

Nello STEP 2 inserire come valore di test l'ID del Lead che si vuole eliminare in formato webservice, quindi del tipo "2xCRMID", ad esempio:

Screenshot_20240411_163208.png

In questa azione non è necessario configurare lo STEP 3 relativo all'output.

Congratulazioni! La creazione dell'integrazione è completa.

Si può ora passare a configurare degli specifici ZAP per compiere le azioni che si desiderano.

Back to top