ballerinax/hubspot.crm.contact Ballerina library

Overview

This is a generated connector from HubSpot OpenAPI specification.

This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the CRM Object Properties API.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create a HubSpot developer account
• Obtain tokens
  • Use this guide to obtain the credentials which are needed to create the <CLIENT_ID> and <CLIENT_SECRET>

Quickstart

To use the HubSpot CRM Contacts connector in your Ballerina application, update the .bal file as follows:

Step 1 - Import connector

First, import the ballerinax/hubspot.crm.contact module into the Ballerina project.

import ballerinax/hubspot.crm.contact;

Step 2 - Create a new connector instance

You can now make the connection configuration using the access token.

contact:ClientConfig clientConfig = {
    auth : {
        token: <ACCESS_TOKEN>
    }
};

contact:Client baseClient = check new Client(clientConfig);

Step 3 - Invoke connector operation

1. Create a contact instance

contact:SimplePublicObjectInput contact = {
    properties : {
        "city": "Cambridge",
        "domain": "biglytics.net",
        "industry": "Technology",
        "name": "Biglytics",
        "phone": "(877) 929-0687",
        "state": "Massachusetts"
    }      
};

contact:SimplePublicObject|error bEvent = baseClient->create(contact);

if (bEvent is contact:SimplePublicObject) {
    log:printInfo("Created the contact" + bEvent.toString());
} else {
    log:printError(msg = bEvent.message());
}

2. List contacts

contact:CollectionResponseSimplePublicObjectWithAssociationsForwardPaging|error bEvent = baseClient->getPage();

if (bEvent is contact:CollectionResponseSimplePublicObjectWithAssociationsForwardPaging) {
    log:printInfo("Contact list" + bEvent.toString());
} else {
    log:printError(msg = bEvent.message());
}

4. Use bal run command to compile and run the Ballerina program