Platform — Developer Tools

SDKs

Official Ventryx SDKs wrap the REST API in idiomatic, type-safe interfaces for your language of choice. All SDKs are open source, actively maintained, and follow semantic versioning.

Node.js / TypeScript

Install

npm install @ventryx/sdk

Usage

import { Ventryx } from '@ventryx/sdk';

const client = new Ventryx({ apiKey: process.env.VENTRYX_API_KEY });

// List workflows
const { data } = await client.workflows.list();
console.log(data);

// Emit an event
await client.events.emit({
  type: 'order.placed',
  data: { order_id: 'ord_123', amount: 99.00 },
});

Python

Install

pip install ventryx

Usage

from ventryx import Ventryx
import os

client = Ventryx(api_key=os.environ["VENTRYX_API_KEY"])

# List workflows
workflows = client.workflows.list()
print(workflows.data)

# Emit an event
client.events.emit(
    type="order.placed",
    data={"order_id": "ord_123", "amount": 99.00},
)

Go

Install

go get github.com/ventryx/go-sdk

Usage

package main

import (
    "fmt"
    "github.com/ventryx/go-sdk/ventryx"
)

func main() {
    client := ventryx.NewClient(os.Getenv("VENTRYX_API_KEY"))

    workflows, err := client.Workflows.List(context.Background(), nil)
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(workflows.Data)
}

The Go SDK is currently in beta. API surface may change before v1.0. Pin to a specific minor version in production.

SDK versioning

SDK	Latest	API version	Status
Node.js / TypeScript	v2.4.1	v1	Stable
Python	v2.3.0	v1	Stable
Go	v0.9.2	v1	Beta