Table of Contents

This document presents a list of all major articles for an easy overview.

REST API Reference

• Full AVA REST API v2 documentation.

Getting Started

Introduction

• Platform UI tour
• Contracts and Workspaces
• User Profile Information
• Integration Flow Overview
• Logs Page
• Quota
• Topics

Platform Features

• Integration Component Overview
• Webhook Overview
• OpenID
• Recipes Feature
• Copy and Export flow
• Re-authentication for sensitive actions
• Content-Based Routing Overview
• Real-Time Flows
• Custom Error Handler Overview
• Linking Flows
• Scheduled Executions Overview
• Data Mapping
• Embedded Recipe Overview

Tutorials

• Creating a Basic Integration Flow
• Creating a webhook flow
• Understanding Actions and Triggers
• Choosing a Trigger
• Choosing an Action

Integrator guide

Building integration flows

• Building integration flow
• Building real-time flows
• Understanding Credentials
• Understanding Data Sample
• Understanding Secrets
• Component version
• VPN Agent
• Executions Page
• Scheduled executions
• Containers Page

Integration patterns

• Content-Based Routing
• Using Snapshots
• Sending data to a list of recipients
• How to cause or emit a Rebound?
• Passthrough Feature

Data transfer

• Mapping Data
• Transforming data
• Flow Queues
• Flow Control
• Rebound Feature
• Flow Linking feature

Troubleshooting

• General Troubleshooting Guide
• Platform Behavior
• Managing Flow Errors
• Custom Error Handler
• Understanding Sample errors
• Update all components in flow

Contract Management

• Configuring Help Links
• Managing Contracts
• Managing Flows
• Managing Limit Quotas
• Managing user roles in a contract
• Managing Workspaces
• OAuth Callback redirect URL

Working with XML

• General rules of processing of XML data
• Getting XML data into the platform

Recipes Feature

• Copying flow through recipes feature
• Creating and managing Recipes
• Recipe Deployment
• Recipe access rights
• Embedded Recipe
• Embedded Recipe Deployment
• External agencies use case

Components

AI-related components

• AI Hacker Buster component
• ChatGPT component
• Claude AI component
• Gemini component
• Grok component
• Manus AI component

CRM components

• Apptivo component
• Close CRM component
• Creatio component
• HubSpot Webhook component
• HubSpot component
• Kommo component
• Microsoft Dynamics NAV OData component
• Microsoft Dynamics CRM v2 component
• Microsoft Dynamics CRM component
• Pipedrive component
• Podio component
• Salesforce-cpq component
• Salesforce component
• Square component
• SugarCRM component
• Zoho CRM component
• Zoho Subscriptions component

Database components

• Airtable component
• Google BigQuery component
• Google Cloud Storage component
• JDBC component
• MongoDB component
• MsSQL component
• Oracle REST Data Services component
• PostgreSQL component
• Snowflake component

ERP components

• AFAS component
• Microsoft Dynamics Business Central component
• Microsoft Dynamics NAV component
• Microsoft Dynamics Business Central On-Premise
• Microsoft Dynamics for Finance and Operations component
• NetSuite REST API OAuth Client Credentials
• NetSuite component
• Odoo component
• SAP Business One component
• SAP ByDesign component
• SAP ECC (R/3, ERP) component

Finance-related components

• Exact Online component
• Mercado Pago component
• PayPal component
• Quickbooks component
• Stripe component
• Xero component

E-Commerce components

• Akeneo component
• Amazon MWS component
• Amazon Selling Partner component
• AppDirect component
• Bazaarvoice component
• BigCommerce component
• ChannelAdvisor component
• ChannelEngine component
• Commercetools component
• Dun-and-bradstreet component
• Ebay component
• Google-shopping component
• Lightspeed-ecom component
• Lightspeed-retail component
• Lightspeed-retail Technical Notes
• Magento1 component
• Magento 2 component
• Pimcore component
• Plytix component
• SaleSphere component
• Shopify Admin v2 component
• Shopify component
• Shopware 6 component
• Shopware component
• Vtex component
• WooCommerce component

Office components

• Docusign component
• Docuware component
• Dropbox component
• Gmail component
• Google Calendar component
• Google Drive component
• Google Spreadsheets v2 component
• Google Spreadsheets component
• iLovePDF component
• Microsoft OneDrive component
• Outlook component
• PandaDoc component
• Picsart component
• SharePoint component
• Tableau Cloud component
• Trumba component

Marketing-related components

• Assetbank component
• Bynder component
• Frontify component
• Google Analytics component
• Goto-webinar component
• Kit component
• Klaviyo component
• Mailchimp component
• Mandrillapp component
• Marketo component
• MediaValet component
• Sdl-translate component
• Telegram component
• X (Twitter) Component

Utility components

• Batch component
• Code component with Credentials
• Code component
• Configuration component
• CSV component
• Delta Detection component
• Email component with Credentials
• Email component
• Filter component
• Flow Linking component
• HJSON component
• ID Linking component
• iPaaS Core component
• iPaaS inter sync component
• Transformation component
• Lookup Table component
• Maester component
• Mapper component
• Open API component
• Petstore-java component
• Petstore-nodejs component
• HTTP Reply component
• Rest API OAuth2 Client Credentials component
• Rest API NTLM Auth component
• REST API with Arbitrary Token Authentication component
• REST API component
• Router component
• S2 (Simple Storage) component
• Simple Trigger component
• Splitter component
• Utility сomponent
• Webhook component
• XML component
• ZIP/UnZIP component

Protocol components

• AMQP component
• AWS S3 component
• AWS SNS component
• AWS SQS component
• Edifact-parser component
• Git-Protocol component
• Google PubSub component
• GraphQL component
• Kafka component
• Ldap component
• ODATA component
• Pub-Sub component
• SFTP component
• SOAP component

Service components

• Allmysms component
• AWS Lambda component
• Basecamp component
• ChannelEngine Technical Notes
• ChatGPT component Technical Notes
• Click Send SMS component
• DeepL component
• Facebook component
• Freshworks component
• Google-translate component
• JDE E1 Orchestrator component
• Jira Cloud component
• Keenio component
• Keenio Technical Notes
• LinkedIn component
• Lionbridge-translation component
• Looker Studio component
• Microsoft Azure AD component
• Microsoft Fabric component
• Microsoft Power BI
• Monday component
• Notion component
• Oracle E-Business Suite component
• Pinterest component
• Qualtrics component
• ServiceNow component
• Slack component
• Smarty-streets component
• WhatsApp component
• Wordpress component
• Youtube component
• Zendesk Component
• Zoom Webhook component

Component Developers

How-Tos and Tutorials

• Deploying a component
• Software Development Kit - SDK
• Building a component in Java
• Building a component in Node.js
• Managing your Teams/Components
• Real-time Flows and component re-deployment
• Rebound Feature
• Using Attachments
• Using Shapshot
• Managing SSH Keys

Component Troubleshooting

• SSH session during the component pushing
• Error Retry and Retention Policy

Behaviour Checks

• Limitations on Attachments
• package.json and Dependencies

Developer Reference

• Defining environment variables for components
• Environment variables available during component execution
• View Classes
• Fields vs Metadata

Paging

• Why to use paging with rest API requests?
• How to implement the pagination?
• What to do when API provider does not support paging?

Component Template Features

• Components build configuration requirements
• Component.json Overview
• Credentials in Component.json
• Actions & Triggers in Component.json
• Ordering fields in component.json
• Fields in Component.json
• Metadata Schemas for Components
• OAuth in Component.json
• Try Metadata Tool

Tokens in OAuth2 components

• Approach to send requests to OAuth2 APIs
• Here is how the OAuth2 process works
• OAuth2 setup preparation in component.json
• Preparing the verifyCredentials.js for oauth
• How to access access_token during component execution?

Releases

Product Updates

• Product Update - v24.01
• Product Update - v24.05
• Product Update - v24.09
• Product Update - v24.13
• Product Update - v24.17
• Product Update - v24.23
• Product Update - v24.27
• Product Update - v24.36
• Product Update - v24.40
• Product Update - v24.45
• Product Update - v24.50
• Product Update - v25.06
• Product Update - v25.10
• Product Update - v25.14
• Product Update - v25.20
• Product Update - v25.23
• Product Update - v25.36
• Product Update - v25.42
• Product Update - v25.43
• Product Update - v25.45
• Product Update - v25.49
• Product Update - v26.03
• Product Update - v26.10
• Product Update - v26.15
• Product Update - v26.19
• Product Update - v26.23
• Product Update - v26.27
• Product Update - v26.32
• Product Update - v26.36.1

Archives

References

Sailor

• Sailor Hooks
• Sailor compatibility matrix
• Sailor Logger
• List of events emitted by the components
• EmitData
• EmitError
• EmitEnd

Working with Java

• Supported Java version
• Java Build proces
• Java components behind a proxy

Support

Support

• Reporting an issue
• Support availability

Platform Specific Settings

Security and Compliance