ballerinax/hubspot.crm.pipeline Ballerina library

2.3.1

Overview

This is a generated connector from HubSpot OpenAPI specification.

This API provides access to pipelines. Pipelines represent distinct stages in a workflow, like closing a deal or servicing a support ticket. These endpoints provide access to read and modify pipelines in HubSpot. They support deals and tickets object types.

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

Step 1 - Import connector

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

Copy
import ballerinax/hubspot.crm.pipeline;

Step 2 - Create a new connector instance

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

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

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

Step 3 - Invoke connector operation

  1. Create a pipeline instance
Copy
pipeline:PipelineInput event = {
    stages: [
        {
            label: "In progress",
            displayOrder: 0,
            metadata: {
                "ticketState": "OPEN",
                "probability": 0.5
            }
        }
    ],
    label: "My replaced pipeline",
    displayOrder: 0
};

pipeline:PipelineInput|error bEvent = baseClient->create("deals", event);

if (bEvent is pipeline:PipelineInput) {
    log:printInfo("Created the pipeline" + bEvent.toString());
} else {
    log:printError(msg = bEvent.toString());
}
  1. List pipelines
Copy
pipeline:CollectionResponsePipeline|error bEvent = baseClient->getAll("deals");

if (bEvent is pipeline:CollectionResponsePipeline) {
    log:printInfo("Pipeline 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.pipeline;Copy

Metadata

Released date: 10 months ago

Version: 2.3.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 

Current verison: 0


Weekly downloads


Source repository


Keywords

Sales & CRM/Customer Relationship Management
Cost/Freemium

Contributors

Other versions

See more...