Table of Contents

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

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

Tutorials

• Creating a Basic Integration Flow
• Creating a webhook flow

Integrator guide

Building integration flows

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

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

CRM components

• HubSpot Webhook component
• HubSpot component
• Kommo component
• Microsoft Dynamics NAV OData component
• Microsoft Dynamics CRM v2 component
• Microsoft Dynamics CRM component
• Pipedrive component
• Salesforce-cpq component
• Salesforce Component
• Square component
• SugarCRM component
• Zoho CRM component
• Zoho Subscriptions component

ERP components

• 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 ByDesign component
• SAP ECC (R/3, ERP) Component

E-Commerce components

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

Marketing-related components

• Google Analytics component
• Goto-webinar component
• Klaviyo component
• Mailchimp component
• Mandrillapp component
• Marketo component
• Sdl-translate component
• Telegram component
• Twitter component
• X (Twitter) Component

Finance-related components

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

Office components

• Docusign component
• Docuware component
• Dropbox component
• Gmail Component
• Google Spreadsheets component v2
• Google Spreadsheets component
• Microsoft OneDrive component
• Outlook component
• Picsart component
• Tableau Cloud component

Protocol components

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

Service components

• Allmysms component
• AWS Lambda component
• Bynder Component
• ChannelEngine component
• ChannelEngine Technical Notes
• ChatGPT component
• ChatGPT component Technical Notes
• DeepL component
• Facebook component
• Gemini component
• Google-translate component
• JDE E1 Orchestrator component
• Jira Cloud component
• Kafka component
• Keenio component
• Keenio Technical Notes
• Lionbridge-translation component
• Looker Studio component
• Microsoft Azure AD Component
• Microsoft Power BI
• Monday component
• Notion Component
• Oracle E-Business Suite Component
• Pinterest Component
• Qualtrics component
• Slack component
• Smarty-streets component
• WhatsApp Component
• Youtube component
• Zendesk Component

Database components

• Google BigQuery Component
• Google Cloud Storage component
• JDBC Component
• MongoDB component
• MsSQL component
• PostgreSQL Component
• Snowflake Component

Utility components

• Batch component
• Code component with Credentials
• Code component
• Configuration component
• Delta Detection Component
• Email component with Credentials
• Email component
• Filter component
• Flow Linking component
• Freshworks component
• HJSON component
• ID Linking component
• IPaas Core component
• Jsonata component
• Simple Storage component
• Lookup Table component
• Maester Component
• Mapper component
• Open API Component
• Petstore-java component
• Petstore-nodejs component
• Plytix 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
• Simple-trigger component
• Splitter component
• Ukraine alerts Component
• Utility Component
• Vtex component
• Webhook component
• ZIP/UnZIP 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 - v20.03
• Product Update - v20.07
• Product Update - v20.11
• Product Update - v20.15
• Product Update - v20.19
• Product Update - v20.23
• Product Update - v20.27
• Product Update - v20.31
• Product Update - v20.35
• Product Update - v20.39
• Product Update - v20.43
• Product Update - v20.47
• Product Update - v20.51
• Product Update - v21.02
• Product Update - v21.06
• Product Update - v21.10
• Product Update - v21.14
• Product Update - v21.19
• Product Update - v21.23
• Product Update - v21.27
• Product Update - v21.31
• Product Update - v21.33
• Product Update - v21.35
• Product Update - v21.37
• Product Update - v21.39
• Product Update - v21.41
• Product Update - v21.43
• Product Update - v21.45
• Product Update - v21.47
• Product Update - v21.49
• Product Update - v21.51
• Product Update - v22.02
• Product Update - v22.04
• Product Update - v22.06
• Product Update - v22.08
• Product Update - v22.10
• Product Update - v22.12
• Product Update - v22.14
• Product Update - v22.16
• Product Update - v22.18.1
• Product Update - v22.20
• Product Update - v22.22
• Product Update - v22.24
• Product Update - v22.26
• Product Update - v22.28
• Product Update - v22.30
• Product Update - v22.32
• Product Update - v22.34
• Product Update - v22.36
• Product Update - v22.38
• Product Update - v22.40
• Product Update - v22.42
• Product Update - v22.44
• Product Update - v22.46
• Product Update - v22.48
• Product Update - v22.50
• Product Update - v22.52
• Product Update - v23.02
• Product Update - v23.04
• Product Update - v23.06
• Product Update - v23.08
• Product Update - v23.10
• Product Update - v23.12
• Product Update - v23.14.1
• Product Update - v23.14
• Product Update - v23.19.1
• Product Update - v23.19
• Product Update - v23.24
• Product Update - v23.27.1
• Product Update - v23.27
• Product Update - v23.31
• Product Update - v23.39
• Product Update - v23.44
• Product Update - v23.48
• 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

Archives

• Product Updates in 2018 Q4
• Product Updates in 2019 Q1
• Product Updates in 2019 Q2
• Product Updates in 2019 Q4

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

elastic.io Specific Settings

• Egress IP Addresses for IP Whitelisting

Security and Compliance

• ISO 27001 Certification

On-Prem

Helm3 deployments

• General Description
• Common Values
• Namespaces
• Secrets

Operation Guides

• Release Process
• Support Process
• Memory Configurations
• IP White-Listing

Installation Guides

• GrayLog Installation
• ClickHouse Installation
• ZooKeeper Installation
• OpenID Configuration
• Oauth Management
• Bran Migration
• Installing the Bran
• Cert Manager
• Quotas service

Platform Administration

• Tenant Administration
• Quota Management
• Monitoring and Alerting

Platform microservices

• MongoDB
• RabbitMQ
• Elasticsearch
• GrayLog
• ClickHouse
• Kubernetes Cluster

White Labelling

• Platform Emails