Skip to main content

Developer README for the vtiger adaptor

Source: https://github.com/OpenFn/adaptors/tree/main/packages/vtiger

Language Vtiger

Language Pack for building expressions and operations to make calls to the Vtiger API.

Documentation

sample configuration

{
"hostUrl": "https://openfunction.od2.vtiger.com",
"username": "taylor@openfn.org",
"accessToken": "blahBlahBlah"
}

sample listTypes expression

listTypes();

sample postElement expression

postElement({
operation: "create"
elementType: "leads",
element: {
"name": dataValue("name")(state),
"surname": dataValue("surname")(state),
"email": dataValue("email")(state)
}
});


Development

Clone the adaptors monorepo. Follow the Getting Started guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To just build the docs run pnpm build docs