Skip to content

Hubspot

HubspotReader #

Bases: BaseReader

Hubspot reader. Reads data from a Hubspot account.

Parameters:

Name Type Description Default
access_token(str)

Hubspot API key.

 required
Source code in llama-index-integrations/readers/llama-index-readers-hubspot/llama_index/readers/hubspot/base.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class HubspotReader(BaseReader):
    """Hubspot reader. Reads data from a Hubspot account.

    Args:
        access_token(str): Hubspot API key.
    """

    def __init__(self, access_token: str) -> None:
        """Initialize Hubspot reader."""
        self.access_token = access_token

    def load_data(self) -> List[Document]:
        """Load deals, contacts and companies data from Hubspot.

        Returns:
            List[Document]: List of documents, where each document represensts a list of Hubspot objects
        """
        from hubspot import HubSpot

        api_client = HubSpot(access_token=self.access_token)
        all_deals = api_client.crm.deals.get_all()
        all_contacts = api_client.crm.contacts.get_all()
        all_companies = api_client.crm.companies.get_all()
        return [
            Document(
                text=f"{all_deals}".replace("\n", ""), extra_info={"type": "deals"}
            ),
            Document(
                text=f"{all_contacts}".replace("\n", ""),
                extra_info={"type": "contacts"},
            ),
            Document(
                text=f"{all_companies}".replace("\n", ""),
                extra_info={"type": "companies"},
            ),
        ]

load_data #

load_data() -> List[Document]

Load deals, contacts and companies data from Hubspot.

Returns:

Type Description
List[Document]

List[Document]: List of documents, where each document represensts a list of Hubspot objects
Source code in llama-index-integrations/readers/llama-index-readers-hubspot/llama_index/readers/hubspot/base.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def load_data(self) -> List[Document]:
    """Load deals, contacts and companies data from Hubspot.

    Returns:
        List[Document]: List of documents, where each document represensts a list of Hubspot objects
    """
    from hubspot import HubSpot

    api_client = HubSpot(access_token=self.access_token)
    all_deals = api_client.crm.deals.get_all()
    all_contacts = api_client.crm.contacts.get_all()
    all_companies = api_client.crm.companies.get_all()
    return [
        Document(
            text=f"{all_deals}".replace("\n", ""), extra_info={"type": "deals"}
        ),
        Document(
            text=f"{all_contacts}".replace("\n", ""),
            extra_info={"type": "contacts"},
        ),
        Document(
            text=f"{all_companies}".replace("\n", ""),
            extra_info={"type": "companies"},
        ),
    ]