Last updated on October 23, 2026
SDK
Install the Appnigma SDK in your product and call your microserver from TypeScript, Ruby or Python.
What the SDK does
The SDK is the package your product installs to reach its Appnigma microserver. With it, your product can:
- send records to an end customer's HubSpot and read them back
- read contacts, companies and deals in one shape, whichever CRM the end customer uses
- run your own functions
- call any platform's API
- connect end customers
An end customer is one of your own customers: the company that owns the CRM account your product works with.
There is one package for every Appnigma customer. Nothing about your account is inside it, and it holds no secret: the key is yours to supply.
The SDK comes as a TypeScript package, a Ruby gem and a Python package. All three return the same error codes and follow the same retry rules. They make the same calls, except for actions and the types command, which only the TypeScript package has for now. Names follow each language's style, so createLink in TypeScript is create_link in Ruby and Python. Every example in these pages has a tab for each language.
Install
npm install @appnigma/sdkNode 20 or newer. Works from ESM (import) and CommonJS (require). TypeScript types are included, and the package has no dependencies.
gem install appnigma-sdkOr in your Gemfile:
gem "appnigma-sdk"Ruby 3.3 or newer, tested on 3.3, 3.4 and 4.0. Not tied to Rails or any framework.
pip install appnigma-sdkIt is imported as appnigma. Python 3.11 or newer, tested on 3.11 to 3.15. Not tied to Django, Flask or any framework.
Start here
The SDK key
Where your key comes from, where to keep it, and how the client reads it.
Post a record
Create a record in an end customer's HubSpot, or update the one that matches.
Read records: pull
Read records back, one page at a time.
Connecting an end customer
Send a link so an end customer connects their account, then check it worked.
CRM data
Read contacts, companies and deals in one shape, whichever CRM.
Any platform call: request
Call the platform's own API for anything else.
Ready-made actions
Run jobs Appnigma keeps up to date. TypeScript only for now.
Your functions: catalog and run
List the functions written for you, and run one.
Types for your functions
Let your editor check function names and inputs. TypeScript only.
Your own guide
A guide written for your company, with your functions.
Errors
Every error class and code, and what to do about each.
Retries and time limits
Which calls are tried again, and for how long.
Settings
Every client setting, with its default.