Skip to main content

Integrations and connectors

DecisionHub connects to external systems in three ways:

  • an HTTP Client HubItem defines a reusable request to a web API;
  • a solution connector stores environment-specific access to a supported system;
  • workflow integration nodes use those definitions to query, update, subscribe, or publish.

Keep configuration separate from business logic. A Workflow should refer to a connector or HTTP Client rather than embedding environment URLs and credentials in mappings or code.

HTTP Client HubItems

An HTTP Client is an executable, versioned HubItem. It can be tested directly and reused by several workflows.

Choose a method and endpoint

Select the method expected by the service, such as GET, POST, PUT, PATCH, or DELETE as offered by the form. Enter the full endpoint URL.

Example:

GET https://customer.example.com/v1/customers/{customerId}

Use modeled or parameter values for variable parts rather than creating one client per customer. Keep the host appropriate for the environment; if the form supports environment configuration through variables or connectors, do not hard-code a production endpoint into a development-only version.

Authentication

TypeFieldsTypical use
NoneNo credentialPublic or network-protected service
BasicUsername and passwordLegacy/basic-auth API
BearerTokenToken-authenticated API
API KeyHeader name and valueVendor API key in a custom header

Credentials are sensitive. Enter them only in the protected authentication fields, not in the URL, request body, test payload, description, or screenshots.

Headers and content type

Add only headers required by the service, for example:

Accept: application/json
X-Correlation-ID: mapped execution value

For a JSON request body, select the appropriate JSON content type. Do not manually create an Authorization header when the authentication section already manages it.

Request body

For POST/PUT/PATCH, define a body that follows the external contract. Example payment-risk request:

{
"transactionId": "TX-8181",
"amount": 349.95,
"currency": "NZD",
"customerId": "C-1007"
}

Use mappings in the workflow node to provide dynamic values. Avoid sending the entire DecisionHub input when the service requires only a few fields.

Response model

Select or define a Data Model for the response used by downstream logic. If the external service returns a large document, model the fields you rely on:

{
"customerId": "C-1007",
"status": "Active",
"riskFlags": ["ADDRESS_CHANGED"]
}

This creates clear field mappings and makes contract changes visible.

Test directly

Testing Zone can execute the HTTP Client without a workflow. Verify:

  • URL and parameter substitution;
  • authentication;
  • headers and body serialization;
  • success response mapping;
  • representative error responses;
  • timeout and rate-limit behavior.

Then use the client from a Workflow HTTP Client node. Saved workflow tests can mock the node for repeatability while separate integration tests exercise the real service.

Create a solution connector

Open Solution → Connectors, select Create Connector, and enter:

  • Name: recognizable display name, such as Salesforce - Production;
  • Identifier: stable reference suitable for configuration and logs;
  • Type: system/protocol to connect to;
  • Environment: where this configuration applies;
  • type-specific connection and authentication fields.

Create and test a configuration for every environment that runs the workflow. A Development connector does not supply Production credentials. When editing, a blank existing-secret field retains the stored secret only where the form explicitly says so.

Database connectors

PostgreSQL, MySQL, Oracle, and SQL Server

Configure host, port, database or service name, username, password, and TLS mode.

TLS modeMeaning
DisableDo not negotiate TLS; use only in a trusted setup where policy allows it
PreferUse TLS when supported
RequireReject a connection that cannot use TLS

Use a least-privilege database account. Connectivity testing proves the credentials and network path, not that every future query is authorized.

Snowflake

Configure account, username, password, database, warehouse, and optional schema and role. Grant the configured role access only to the required warehouse and objects.

REST API Credentials connector

This connector stores a base URL and authentication configuration for REST-based features. Authentication options include none, basic, bearer, or API key. API keys can be placed in a header or query parameter according to the external service, although headers are preferable when supported.

Example:

Base URL: https://api.vendor.example/v2
Authentication: API Key
Location: Header
Name: X-Vendor-Key
Value: [stored secret]

AI connectors

Provider connectors for Google Gemini, Anthropic, and OpenAI accept the provider API key. Custom AI configuration can also include base URL, model, authentication-header style, organization, and Azure API version where applicable.

Creating an AI connector does not itself add a generic AI workflow node. It makes credentials available to platform features that explicitly support that connector. Test the connection and confirm the consuming feature before planning a production process around it.

Kafka connector

Enter the bootstrap servers and security protocol:

  • PLAINTEXT or SSL;
  • SASL_PLAINTEXT or SASL_SSL.

For SASL, select the mechanism offered by the cluster: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, OAuth bearer, or GSSAPI. Then enter the relevant username/password or OAuth client ID, client secret, token endpoint, and scope. Schema Registry URL is optional.

Use Test to verify connectivity, then confirm topic discovery. A successful broker connection does not guarantee the identity can consume or publish every topic.

Salesforce connector

Configure:

  • Salesforce instance URL;
  • Connected App client ID and secret;
  • Salesforce organization ID;
  • Platform Event endpoint;
  • Salesforce API version.

The connected app needs only the permissions required by the selected objects and events. Test the connector before using Salesforce Data or Platform Event nodes.

Dynamics 365 Sales connector

Configure the Dynamics environment URL, Microsoft Entra tenant, application client ID and secret, and authority. Connector creation and testing may be available before a workflow node exposes a Dynamics operation; the Workflow Elements palette is authoritative for current runtime use.

Connector health and integration activity

Event-enabled workflows expose health information such as active subscriptions, pending deliveries, successful deliveries, retries, and dead letters. Organization → Integration Activity provides a broader view and can be filtered by trigger/publisher, status, provider, and endpoint.

Use both views when troubleshooting:

  1. Connector test: can DecisionHub authenticate and reach the system?
  2. Workflow health: is the deployed subscription or publisher operating?
  3. Integration Activity: what happened to a particular delivery?
  4. Execution History: what business logic ran for that delivery?

Security and maintenance checklist

  • Use one environment configuration per runtime environment.
  • Store secrets only in protected fields and rotate them on a schedule.
  • Use least-privilege external identities.
  • Require TLS where the external system supports it.
  • Model only response fields the workflow actually needs.
  • Define timeout, retry, rate-limit, and partial-failure expectations.
  • Monitor dead letters and assign an operational owner.
  • Retest connectors after credential, network, API-version, or certificate changes.
Supported integrations

The Connectors form and Workflow Elements palette show the supported catalog for your installation and plan. A generic webhook, Slack, Teams, GraphQL, or plugin marketplace integration is not exposed by this interface.