Tutorial: Creare un workflow con HubSpot come sorgente

Un esempio pratico di utilizzo di Portant Developer API per creare un workflow con HubSpot come sorgente. Tutte le richieste utilizzano cURL. Sostituire <DEVELOPER_ACCESS_TOKEN> con il token fornito dal team di integrazioni di Portant.

Suggerimento: prima di iniziare, creare ed eseguire un workflow nell'applicazione web Portant Workflow in modo da acquisire familiarità con il funzionamento dei workflow. Si consiglia di utilizzare un template Google Docs, che conferma inoltre che l'account è correttamente autorizzato con le API di Google.

Questo tutorial presuppone che siano stati completati i passaggi descritti nella guida Developers overview e che l'account Portant sia già connesso a HubSpot.

Passaggio 1. Creare un workflow

Il workflow verrà denominato "Developer Workflow" e creato tramite l'endpoint Workflows POST, specificando una sorgente HubSpot.

curl --location --request POST 'https://api.portant.co/v0/workflows/' \
--header 'Authorization: <DEVELOPER_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Developer Workflow",
    "source": {
        "sourceType": "HUBSPOT",
        "hubspotObjectTypeId": "0-3",
        "hubspotProperties": ["0-3.dealname", "0-1.firstname"]
    }
}'

Una sorgente HubSpot richiede due campi aggiuntivi oltre a sourceType:

hubspotObjectTypeId (String) Il tipo di oggetto HubSpot principale per questo workflow. Utilizza la convenzione degli ID tipo oggetto di HubSpot: 0-3, ad esempio, è l'ID tipo oggetto per i Deal. Consultare il riferimento agli ID tipo oggetto di HubSpot per l'elenco completo.

hubspotProperties (Array<String>) Le proprietà da includere come campi sorgente per questo workflow, ciascuna nel formato <objectTypeId>.<internalFieldName>, dove objectTypeId è l'ID tipo indicato sopra e internalFieldName è il nome interno di quella proprietà in HubSpot. Nell'esempio precedente, 0-3.dealname recupera il nome del deal e 0-1.firstname recupera il nome del contatto associato.

Una richiesta riuscita restituisce 201 Created con il nuovo workflow. Salvare il valore id, che verrà utilizzato per aggiungere un template nel passaggio successivo.

Passaggio 2. Aggiungere un template e attivare il workflow

Da questo punto il workflow si comporta come qualsiasi altro. I passaggi rimanenti sono identici a quelli del tutorial relativo ai webhook:

• Create a template document per aggiungere il file che viene unito.
• Listen for automation events per ricevere notifiche quando i documenti vengono creati.

Una volta che il workflow dispone sia di una sorgente HubSpot sia di almeno un template, il suo status diventa "COMPLETE" e viene eseguito ogni volta che un oggetto HubSpot corrispondente lo attiva.

Per i dettagli su ogni endpoint e risorsa, consultare il resto dei riferimenti API. Per domande o richieste di nuove funzionalità, contattare il team di customer success o il team di integrazioni.