@orchesty/connector-typeform
v2.0.0
Published
[](https://www.npmjs.com/package/@orchesty/connector-typeform) [](https://github.com/Orchesty/orchesty-nodejs-
Readme
Typeform Connector
An Orchesty connector for Typeform, a web-based platform for building interactive surveys, forms, and apps without writing code.
Application Type
OAuth 2.0
This connector uses the Typeform OAuth 2.0 authorization flow. After entering your credentials in Orchesty, you will be redirected to Typeform to authorize access.
| Field | Description |
|---|---|
| client_id | Your Typeform app Client ID |
| client_secret | Your Typeform app Client Secret |
Components
| Class | Type | Description |
|---|---|---|
| TypeformCreateFormConnector | Connector | Creates a new form via POST /forms |
| TypeformCreateWorkspaceConnector | Connector | Creates a new workspace via POST /workspaces |
| TypeformUpdateFormConnector | Connector | Updates an existing form via PUT /forms/{form_id} |
Setup
Credentials
- Log in to Typeform and navigate to Admin → Developer apps.
- Create a new app and note the Client ID and Client Secret.
- Add the Orchesty redirect URL to the Redirect URIs list.
- In Orchesty, open the Typeform application settings, enter both values, and complete the OAuth authorization flow.
API Documentation
Typeform API: https://www.typeform.com/developers/
Installation & Usage
Install the package:
npm install @orchesty/connector-typeform @orchesty/nodejs-sdk
# or
pnpm add @orchesty/connector-typeform @orchesty/nodejs-sdkRegister the application and nodes in your Orchesty DI container:
import { container } from '@orchesty/nodejs-sdk';
import { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
import TypeformApplication from '@orchesty/connector-typeform/dist/TypeformApplication';
import TypeformCreateFormConnector from '@orchesty/connector-typeform/dist/Connector/TypeformCreateFormConnector';
import TypeformCreateWorkspaceConnector from '@orchesty/connector-typeform/dist/Connector/TypeformCreateWorkspaceConnector';
import TypeformUpdateFormConnector from '@orchesty/connector-typeform/dist/Connector/TypeformUpdateFormConnector';
const app = new TypeformApplication(container.get(OAuth2Provider));
container.setApplication(app);
container.setNode(new TypeformCreateFormConnector(), app);
container.setNode(new TypeformCreateWorkspaceConnector(), app);
container.setNode(new TypeformUpdateFormConnector(), app);License
This connector is released under the Apache License 2.0. See the LICENSE file for the full license text.
Contributing
Contributions are welcome! This connector is part of the open-source Orchesty Node.js Connectors monorepo.
For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the Contributing to Connectors guide.
All contributions should include:
- Source code in
src/following the existing connector structure - Tests in
src/**/__tests__/withinput.json,mock.json, andoutput.jsonfixtures - An updated
CHANGELOG.mdentry
