Tutorial: Criar um workflow com HubSpot como fonte
Um exemplo prático de uso da Portant Developer API para criar um workflow com HubSpot como fonte. Todas as requisições utilizam cURL. Substitua <DEVELOPER_ACCESS_TOKEN> pelo token fornecido pela equipe de integrações da Portant.
Dica: antes de começar, crie e execute um workflow no aplicativo web Portant Workflow para se familiarizar com o funcionamento dos workflows. Recomendamos um template no Google Docs, o que também confirma que sua conta está corretamente autorizada com as APIs do Google.
Este tutorial pressupõe que você já concluiu as etapas do guia Visão geral para desenvolvedores e que sua conta Portant já está conectada ao HubSpot.
Passo 1. Criar um workflow
Vamos nomear o workflow como "Developer Workflow" e criá-lo com o endpoint Workflows POST, passando uma fonte 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"]
}
}'
Uma fonte HubSpot requer dois campos adicionais além de sourceType:
hubspotObjectTypeId (String) O tipo de objeto HubSpot principal para este workflow. Utiliza a convenção de ID de tipo de objeto do próprio HubSpot: 0-3, por exemplo, é o ID de tipo de objeto para Negócios (Deals). Consulte a referência de IDs de tipo de objeto do HubSpot para a lista completa.
hubspotProperties (Array<String>) As propriedades a serem incluídas como campos de fonte para este workflow, cada uma no formato <objectTypeId>.<internalFieldName>, onde objectTypeId é o ID de tipo acima e internalFieldName é o nome interno dessa propriedade no HubSpot. No exemplo acima, 0-3.dealname obtém o nome do negócio e 0-1.firstname obtém o primeiro nome do contato associado.
Uma requisição bem-sucedida retorna 201 Created com o novo workflow. Salve o valor de id; você o utilizará para adicionar um template em seguida.
Passo 2. Adicionar um template e ativar
A partir daqui, o workflow funciona como qualquer outro. As etapas restantes são idênticas às do tutorial de Webhook:
- Criar um documento de template para adicionar o arquivo que será mesclado.
- Monitorar eventos de automação para receber notificações quando documentos forem criados.
Assim que o workflow tiver uma fonte HubSpot e pelo menos um template, seu status passa a ser "COMPLETE" e ele é executado sempre que um objeto HubSpot correspondente o acionar.
Para detalhes sobre cada endpoint e recurso, consulte o restante da referência da API. Em caso de dúvidas ou solicitações de funcionalidades, entre em contato com a equipe de sucesso do cliente ou de integrações.