Build NetSuite Integration
In this guide, we will walk through the essential steps required to build a NetSuite integration using the Cobalt platform. This process involves three major steps i.e. User Authentication with NetSuite, Creating Workflows and Using workflows for users.
Authenticating with NetSuite integration
To get started, first you need to enable the NetSuite integration in your account and also setup some basic processes.
Enable the NetSuite App
Step 1: Enable the NetSuite App
After setting up your account, the next step is to enable the NetSuite app in your Cobalt account.
To enable the NetSuite app:
Navigate to Apps
in Cobalt and search for Netsuite and enable the app by clicking on the Go Live
button in the top right corner.
Since this is a API Key based app, you do not need to perform any setup forn user authentication.
Follow the steps given here to get your API credentials required for authentication.
Once the app is enabled, you can proceed to create and manage workflows and linked accounts associated with NetSuite.
Create a Linked Account
Step 2: Create a Linked Account
A Linked Account in Cobalt represents the end-users or customers who will use the integration through the platform. Each Linked Account requires a unique linked_account_id, which typically corresponds to an ID from your internal data model (e.g., a user or account ID).
Learn more about Linked Accounts here.
To upsert (create or update) a Linked Account, use the following API call:
Param | Required | Type | Description |
---|---|---|---|
linked_account_id | Mandatory | String | Unique customer identifier |
name | Optional | String | Name of the customer |
You can check the Linked Accounts in your Cobalt account by navigating to the Linked Accounts section in the side menu.
Once the Linked Account is successfully created or updated, it will be ready for authentication in the next step.
Generate Session Token for your Linked Account
Step 3: Generate Token
After creating a Linked Account, the next step is to generate a session token. Session tokens help protect your Cobalt API key and manage end-customer tokens more securely.
To create a session token, use the following API call:
This session token will be included in subsequent requests to Cobalt APIs to authenticate and authorize the actions.
Open Hosted Portal Auth Flow
Step 4: Open Hosted Portal Auth Flow
Next, you will need to generate a Hosted URL that your users will use to authenticate with Salesforce. Cobalt securely stores the credentials and handles API calls on behalf of your users.
Use the following API call to generate the Hosted URL:
The response will return a Hosted URL that your users can visit to authenticate and connect their Salesforce accounts.
Authenticate Using Hosted Portal
Step 5: Perform Key based Authentication
Visit the Hosted URL provided in the API response. The Hosted Portal will display all the integrations you have enabled, including NetSuite.
To authenticate:
- Navigate to the NetSuite integration in the portal.
- Provide the requested credentials.
- Click on Connect to begin successfully authenticate with NetSuite.
You have successfully authenticated with NetSuite integration.
The next step is to create workflows for your use-case.
Creating Workflows in NetSuite
There are 2 major categories of workflows that you can create in NetSuite currently.
Data Import from NetSuite
Sync data from NetSuite to your system.
Push Data to NetSuite
Create data on NetSuite from your system.
Let’s look at a sample workflow for each case.
Data Import from NetSuite
Consider a use-case where you want to sync all the contacts present in NetSuite to your system.
In the NetSuite integration, go to Workflows
and create a new workflow by clicking on +Add Workflow
button and name it as Sync Contacts
.
Data Import from NetSuite
Data Import from NetSuite
Follow the steps given to build the workflow:
Add Trigger in Start Node
All workflows start with a trigger, which determines when the workflow will run and how data is passed into the workflow. For this workflow we will use the Event Based trigger.
Learn more about the triggers and its types here.
Click on the Start Node
, select your native app option and click on + Create New Event
.
Give a name to your event and keep the payload as an empty object.
Add NetSuite Node
Now to fetch all the contacts present in your user’s account, we need to call NetSuite API.
Click on Nodes
option in the top right and drag the NetSuite Node from Native Apps section to the workflow builder. Connect this node with Start Node and select Get Contact
action in the node.
Add Loop node
We fetched all the contacts data from NetSuite, but NetSuite API only sends the IDs of the contacts in the API response, so now we need to loop through all the IDs and get contact data.
Drag the Loop Code from the Utility Nodes section onto the workflow builder and connect it with NetSuite node.
Setup Loop Node
To setup how many iterations the loop node will do, click on it and select Array Iteration
as action and provide the array of IDs that you received from the NetSuite node.
Learn more about Loop node here.
Inside the Loop node we will add the nodes that we want execute in loops. Add a NetSuite node inside the Loop node and select Get Contact by ID
action where you provide a dynamic id based on array item by templating {{node.<Loop_node_no.>.body.array_item.id}}
.
Table Node addition
We are looping through the NetSuite nodes, but we need to store that response in a temporary storage so that we can use it outside the loop. For this purpose, we will use the Table node.
Learn more about Table node here.
Add a Table Node inside the Loop node and select action Add Table Record
to create new rows of data in it.
Before you can add data to a Table, you need to create a Table in the workflow. You can do this step before executing the Loop node and selecting the action Create Table
, which you will then use inside Loop.
Fetch all records
Once the iterations are finished, you need to fetch all the records that were added to the Table.
Add a Table node to the Loop node and select Get Table Records
action and provide the ID of the table where you added records.
Mapping Contact fields
Click on + Map Fields
under Input Parameters, add key name as contacts
and in value we will provide the response received through Table node which will be restructured.
In Value
, select Nodes tab under Insert Variable and click on +
of the Table Node where you fetched all records.
You can now do mapping using JavaScript code. Try the sample code provided below:
API Proxy in Workflow
You have successfully fetched all contacts and structured the payload. Now to receive it in your server, you need to configure an API Proxy.
In Cobalt Dashboard, navigate to Developer
> API Proxies
and click on New Action
. Configure an API endpoint, where you want to receive the response.
If you want to test, go to webhook.site and copy Your unique URL
and configure this as a POST Request and Save
.
Use API Proxy in Workflow
From Native Apps nodes, add your org’s Node and connect it with Custom Code.
Click on the node and select the API Proxy that you created from the Actions. Add the response from Custom Code node in data field and click on Save
.
Ensure that you add a field in the API Proxy where you can pass the JSON data and then added it to the API Call body as well in the POST request.
Hurray!!
You have successfully created a NetSuite workflow to sync all the contacts to your system.
Push Data to NetSuite
Consider a use-case where you want to create a contact present in your system to NetSuite.
This workflow will be fired when you send an Event with the payload of the contact to be added.
In the NetSuite integration, go to Workflows
and create a new workflow by clicking on +Add Workflow
button and name it as Create New Contact
.
Push Data to NetSuite
Push Data to NetSuite
Follow the steps given to build the workflow:
Add Trigger in Start Node
All workflows start with a trigger, which determines when the workflow will run and how data is passed into the workflow. For this workflow we will use the Event Based trigger.
Learn more about the triggers and its types here.
Click on the Start Node
, select your native app option and click on + Create New Event
.
Give a name to your event and provide all the data related to the contact in the payload.
Add NetSuite Node
Now to create a new contact in NetSuite, we need to call NetSuite API.
Click on Nodes
option in the top right and drag the NetSuite Node from Native Apps section to the workflow builder. Connect this node with Start Node.
Add Action in node
Click on NetSuite Node and add the Create Contact
action.
To provide the data in all the fields from your Event payload, just click on a field and from the Event tab under Insert Variable, select the fields from the body that you sent as payload.
Ensure that all the mandatory fields in the action are filled, else the NetSuite API will give error.
Hurray!!
You have successfully created a NetSuite workflow to create a new contact.
You have successfully created the workflows for your use case.
Next step is to enable and execute those workflows for your Linked Accounts.
Executing the Workflows
To run these workflows for your users or Linked Accounts, you need to do the following steps:
Create Config for Linked Account
Config is a customization that you store for each integration of your end-customers.
Create Config
You can create config for the Linked Account through the Cobalt Connect SDKs or using the APIs.
You can use the .config() method or the Create Config API which returns the specified config or creates one if it doesn’t exist for the Linked Account.
Make a request with the Application Slug
and linked_account_id
as mandatory fields for it. You can request in the following way:
It will return information about config of the application for the Linked Account and provides you with all the published workflows and settings input for the user required to execute the workflow.
Enable Workflow
Now you need to enable the workflow for your Linked account. You can either ask the user to enable them or you can do so for them by using the Update Config API or .updateconfig() method.
Make the following request:
In response, you get the updated config information for the application.
Third Step
Once the required workflows are enabled, you need to fire event to start execution. You can use the Trigger Event for app API with the following request:
Congratulations!!
You have successfully created a NetSuite integration and executed it for your users.