🔃 API

This section provides a comprehensive overview of the routes, types, and error codes for the features in the system, ensuring developers understand how to interact with the API and handle potent.

 type CredentialInfo = {
    appName: string;
    fields: CredentialInfoField[];
    desc: string;
};

type CredentialInfoField = {
    name: string;
    /**
     * The type of the field. Can be one of the following:
     *
     * 1. HTML input types: text, password, number etc.
     * (https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input)
     * (except 'checkbox' and 'boolean')
     * 2. 'select' for a selectbox (options must be specified).
     * 3. 'textarea' for fields that can have multiple lines of text.
     *
     * If not specified, defaults to 'text'
     */
    type?: string;
    desc?: string;
    label?: string;
    isOptional?: boolean;
    /**
     * If type is 'select', this is the list of options
     */
    options?: { value: string; label: string }[];
    /**
     * If field should be shown only when a certain condition is met, specify it here.
     */
    showWhen?: {
    	key: string;
    	value: string | number | boolean;
    };
    /**
     * If field is not dependent on another field and will be displayed after a certain event occurs
     */
    show?: boolean;
};

If the request is successful, it returns a 200 status code or other HTTP status codes starting with 2. In case of an error, in addition to standard HTTP status codes, custom error codes will be returned.

GET api/v1/ipaas/projects/:projectId/apps/:appKey/credential-info

Path Parameters

200: OK

CredentialInfo

GET api/v1/ipaas/projects/:projectId/users/:userId/connections/status

Path Parameters

Query Parameters

200: OK

Record<string, 'connected' | 'not-connected' | 'invalid'>

/**
 * Example;
 * { "google-calendar": "connected", "cubicl": "not-connected" }
 */

GET api/v1/ipaas/users/:userId/connections/:appKey

Path Parameters

Response

200: OK

ConnectionDetails

POST api/v1/ipaas/users/:userId/connections/import

Path Parameters

Body

200: OK

// No content

POST api/v1/ipaas/projects/:projectId/users/:userId/connections/:appKey

Path Parameters

Body

200: OK

string | null
// If it is an OAuth application, a connection link is returned.
// For other applications, no response is returned.

POST api/v1/ipaas/automations/:automationId/run

Path Parameters

Body

200: OK

{
    status: 'completed' | 'paused' | 'error' | 'canceled';
    message?: string;
    result?: any
}

POST api/v1/ipaas/automations/:automationId/register

Path Parameters

Body

200: OK

// Trigger Id
String

POST api/v1/ipaas/automations/:automationId/unregister

Path Parameters

Body

200: OK

// No content

DELETE api/v1/ipaas/users/:userId/connections/:appKey

Path Parameters

200: OK

// No content