ballerinax/hubspot.crm.deal Ballerina library

2.3.1

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 Deals connector in your Ballerina application, update the .bal file as follows:

Step 1 - Import connector

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

Copy
import ballerinax/hubspot.crm.deal;

Step 2 - Create a new connector instance

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

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

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

Step 3 - Invoke connector operation

  1. Create a deal instance
Copy
deal:SimplePublicObjectInput deal = {
    properties : {
        "amount": "1500.00",
        "closedate": "2019-12-07T16:50:06.678Z",
        "dealname": "Custom data integrations",
        "dealstage": "presentationscheduled",
        "pipeline": "default"
    }      
};

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

if (bEvent is deal:SimplePublicObject) {
    log:printInfo("Created the deal" + bEvent.toString());
} else {
    log:printError(msg = bEvent.message());
}
  1. List deals
Copy
deal:SimplePublicObjectWithAssociationsArray|error bEvent = baseClient->getPage();

if (bEvent is deal:SimplePublicObjectWithAssociationsArray) {
    log:printInfo("Deal list" + bEvent.toString());
} else {
    log:printError(msg = bEvent.message());
}
  1. Use bal run command to compile and run the Ballerina program

Import

import ballerinax/hubspot.crm.deal;Copy

Metadata

Released date: over 1 year ago

Version: 2.3.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 2

Current verison: 2


Weekly downloads


Source repository


Keywords

Sales & CRM/Customer Relationship Management

Cost/Freemium


Contributors

Other versions

See more...