Unique customer identification id. For Eg: markwood@some_email.com

API Key Auth

Migrate Token for a Linked Account

Headers

Body Parameters

Request description

Response description

x-api-key

Cobalt

Postman

Get Your API Key

Examples

Guides

Implementation & Guides

API Reference

SDKs

Resources

Dashboard

Contact Us

Introduction

This guide will help you understand how you could try out Cobalt platform and the demo workflows.

Quickstart

This page describes common terms used in the Cobalt interface and documentation.

Glossary

In this integration guide, you will sign up for a Cobalt Developer Account, set up Cobalt Connect, integrate the Cobalt API and go into production.

Get Started

Create your Cobalt Developer Account, recieve your API Keys, and build and test on Cobalt.

Create a Cobalt Developer Account

Set Up Linked Accounts

In this guide, you'll create Session Token which makes it easier to manage you end customer's tokens.

Get Session Token

To diplay the apps to your end-users in the frontend, you can develop your own custom UI or redirect your users to Cobalt Connect, which is securely hosted by Cobalt.

Display Apps on the Client-side

Cobalt provides the flexibility for you to manage your customers’ application connections.

Manage App connection

Manager End-user configurations

In this, you'll get to know how you can send data from your app to other apps.

Write data to Third-party Apps

In this, you'll learn how you can fetch data from the workflows by creating Custom Actions or API Proxies.

Get Data with API Proxies

Develop Test Scenarios

In this, users will learn to validate the behavior and output of specific components of Workflows before progressing to more complex configurations.

Node Level Tests

In this, we learn about Orchestration Testing which evaluates the end-to-end behavior and performance of the entire workflow in various scenarios.

Orchestrations Tests

In this guide, we'll learn how you can handle Re-auth of a user for an integration

Handle ReAuth

In this guide, we'll explore how users can effectively handle workflow failures within the Cobalt platform.

Handle Workflow Failures

In this, you will get to know how you can control access of the users to the workflows.

Workflow Access Controls

Validate that your application is ready for deployment with the Cobalt go-live checklist.

Go Live Checklist

Linked Account represents your app's `end user` or `customer` who connects and uses **third-party apps** through your platform.

Linked Accounts

Org Developer Settings

Learn how to setup an API Proxy in Cobalt

API Proxies

Events

Webhooks

Application platforms that you can connect with Cobalt.

Overview

Workflows connect data between your users' apps and your application

Public workflows in Cobalt allow linked accounts to create and execute their own workflows.

Public Workflows

Human Task is the way to involve human input in workflow execution to bring a layer of user interaction.

Human Task

Data Variables

Workflow Testing in Cobalt enables you to test your workflow's functionality by running it with sample payloads as you build it.

Workflow Testing

Templating in Workflows

Data Refs allow you to create and manage references for entities across multiple integrations directly within Cobalt.

Data Refs

Create reusable functions or provides built-in, non-editable library functions in workflows.

Internal Functions

Tables by Cobalt allows users to manage and use dynamic data generated within workflows and are structured with rows and columns.

Tables by Cobalt

User forms define the form layout that you use in the Human Task node.

User Forms

Cobalt's auth flows provides a seamless environment for your users to grant authorization to their third party application data.

Auth flows options

It is a no-code solution, so you don't need to build your own UI to handle the integration authentication

Hosted Flow

Utilize the Cobalt React SDK for frontend and embed it within your React application.

Cobalt Modals

Utilize our REST APIs and NodeJs SDK methods to implement and customize the authentication experience.

Build your own Frontend

Re-Authentication

More about the Try API Settings and how it can assist you to fire and test workflows in Cobalt.

Try API

Logs in Cobalt allow you to monitor workflows, troubleshoot errors during executions, and gain insights into platform activities.

Observability with Logs

Learn how to handle errors and API Rate Limiting

Reliability

Create and integrate your custom applications

Custom Apps Intro

Create a custom app by performing setup from scratch

From Scratch

Create a custom app by simply providing API documentation to our AI

Using Cobalt AI

Create a custom app by using the OpenAPI Spec doc link

Using OpenAPI Spec doc

Understand how to deploy Cobalt on your own infrastructure.

Cobalt Deployment

Choose a hosting option that best fit for your needs

Cobalt Hosting Solutions

This guide helps you install and deploy Cobalt’s on-prem solution on your Kubernetes cluster in AWS. It covers the setup of essential dependencies, including Redis and MongoDB, and guides you through creating a Kubernetes cluster on AWS. After successfully setting up your cluster, you'll configure your environment to pull images from our private Docker repository and install our services via Helm charts.

AWS Deployment

This guide helps you install and deploy Cobalt’s on-prem solution on your Kubernetes cluster in Azure. It covers the setup of essential dependencies, including Redis and MongoDB, and guides you through creating a Kubernetes cluster on Azure. After successfully setting up your cluster, you'll configure your environment to pull images from our private Docker repository and install our services via Helm charts.

Azure Deployment

This guide helps you install and deploy Cobalt’s on-prem solution on your Kubernetes cluster. It covers the setup of essential dependencies, including Redis and MongoDB, and guides you through creating a Kubernetes cluster on GCP. After successfully setting up your cluster, you'll configure your environment to pull images from our private Docker repository and install our services via Helm charts.

GCP Deployment

This guide helps you to install Cobalt using Docker images on any standalone machine. We will use Amazon EC2 as reference in the guide.

On Standalone Machine

Understand Cobalt's​ security practices and architecture.

Security

At Cobalt, we prioritize the security of our systems, services, and customer data. Our security approach is built on industry best practices, proactive risk management, and continuous monitoring to ensure robust protection against threats.

Application Security

Discover the compliance frameworks Cobalt adheres to, demonstrating our commitment to industry-standard security guidelines and best practices.

Compliance & Certifications

You can view our [Privacy Policy](https://www.gocobalt.io/privacy-policy)

Privacy Policy

You can view our [Terms of Use](https://www.gocobalt.io/terms-of-use)

Term of Use

Auth Flows

Logs

Workflow API

Dataslots

How To Configure

Mapping

Dependency of config dataslot is an advanced feature for certain fields that require dependency on previous config dataslot.

Dependent

Field Types

Integrations

Custom App Setup

Custom App setup

Get linked account by ID

Get all linked accounts

Create linked account

Upsert linked account

Delete linked account

Get all applications

Get application by Slug

Upsert Config

Update Config

Get All Installed Configs

Get Config by ID

Delete Config

Get All Config Fields

Get Field Value by ID In Config

Update Field Value by ID In Config

Delete Field Value by ID In Config

Get Options For Rule Engine

Get all Config Datastores

List Records in Datastore

Search Datastore Records

Trigger an event

Trigger an event for single app

Create Webhook

Update Webhook

Get all webhooks

Get webhook by ID

Delete webhook

(Deprecated) Subscribe to events

(Deprecated) Unsubscribe from an event

Get execution by ID

Get all executions

Create Public Workflow

Get all Public Workflows

Get draft of Public Workflow

Register Cron Schedule

Get all Scheduled Jobs

Pause Cron Schedule

Resume Cron Schedule

Update Cron Schedule

Delete Cron Schedule

Generate Token for Linked Account

Create Hosted URL

Get hosted properties

API Proxy

In this, you'll setup the Events and API Proxies required for the integrations

Events & API Proxies

Setup the 3rd Party Apps that you can connect with Cobalt.

Apps Setup

Build End-User Config

To diplay the apps to your end-users in the frontend, you can develop your own custom UI or redirect your users to Cobalt Connect.

Manage End-user configs

Checklist

Build Salesforce Integration

Build NetSuite Integration

Build Workday Integration

General

The Team section within Cobalt's Account Management provides a comprehensive overview of the members associated with your account.

Team

The Access section within Cobalt's Account Management allows account owners to maintain control over their account access.

Access

Brand

Automatically notify your app any time certain changes are made.

More about the Try API Settings and how it can assist you to fire and test events in Cobalt.

About API Reference

Linked Account

Applications

Config

Config Fields

Datastores

Event

Webhooks

Executions

Public Workflows

Schedule

Session Token

Cobalt Hosted

Migrate Token for a Linked Account

Request description

Headers

Body Parameters

Response description

About API Reference

Linked Account

Applications

Config

Config Fields

Datastores

Event

Webhooks

Executions

Public Workflows

Schedule

Session Token

Cobalt Hosted

​Request description

​Headers

​Body Parameters

​Response description

Request description

Headers

Body Parameters

Response description