Dovrai chiamare questo nostro webhook ogni volta che sul tuo CRM verrà creato un nuovo oggetto.
Per oggetto intendiamo un contatto, un lead o un deal.

Ambiente DEV: https://customcrm.webhooks.dev.aisa.247x.io/

Ambiente PROD: https://customcrm.webhooks.aisa.247x.io/

POST /hooks/new

Authorization: Bearer {{Token}}

Invia tutto l’oggetto in formato JSON.

Utilizza la chiave specifica per il relativo oggetto:

{  "contact": { // può essere anche deal o lead    "id" : "",    "firstName": "",    "lastName": "",    "phoneNumber": "",    ...  } }

 

 

Per dare la possibilità ad AISA di aggiornare il tuo CRM dovrai creare un endpoint che permette di creare e aggiornare un oggetto. Per oggetto intendiamo un contatto, un lead o un deal.

È preferibile predisporre questo endpoint con la logica di un upsert, in questo modo con un solo endpoint si può gestire sia la creazione che l’aggiornamento. Se non è possibile creare direttamente un upsert si possono comunque creare due endpoint, uno per la creazione e uno per l’aggiornamento.

Sia se deciderai di creare un unico endpoint di upsert oppure un doppio endpoint di creazione e aggiornamento, il body e gli header da inviare saranno gli stessi e sono condivisi qui sotto.

Dovrai fornirci l’url per eseguire la richiesta, uno solo se farai un upsert, due url se farai creazione e aggiornamento divisi

Authorization: Bearer {{Token}}

Ti invieremo l’oggetto da creare/aggiornare in formato JSON con la sua relativa chiave, deal se è un deal, contact se è un contatto o lead se è un lead.

Ti invieremo l’id dell’oggetto se lo abbiamo, in ogni caso ti invieremo il numero di telefono.

Di solito gli unici campi obbligatori di questo body sono il nome, il cognome ed il numero di telefono, se il tuo CRM ne prevede altri, segnalacelo.

Se il tuo progetto prevede che AISA debba cambiare lo stage o la pipeline dell’oggetto, ti invieremo i rispettivi id nei campi stageId e pipelineId

{  "deal": { // può essere anche contact o lead    "id" : "",    "phoneNumber" : "",    "title": "",    "stageId": "",    "pipelineId": "",    "note": "",    "status": "",    ...  } }

Non abbiamo bisogno che ci restituisca l’oggetto indietro, è sufficiente uno status code 200.

 

Sia il webhook che gli endpoint, in caso di errore, dovranno rispettare queste regole per la gestione degli errori

400

{  "code": 0, // intero  "message" : "...", // stringa  "fields" : ["", ""] // array di stringhe, questo field ci sarà solo se l'errore lo prevede, come ad esempio il code 3 }

 

Mappa degli errori

Code	Message	Significato
1	Contact already exists	Esiste già un contatto con quel numero di telefono
2	Invalid object id	L’id dell’oggetto non è valido, l’oggetto può essere contact, lead o deal
3	Missing required fields: ...	Non sono stati inviati dei fields obbligatori, i fields sono leggibili sia dal message che dal campo “fields” presente nel body
4	Invalid value for fields: ...	Alcuni fields hanno dei valori non validi, i fields sono leggibili sia dal message che dal campo “fields” presente nel body