Skip to content

Connector casing (wave 1 - connectors) #5702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 7, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions docs/components/connectors/connector-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,50 @@ description: "Connectors come in type and subtypes that describe their functiona

Connectors are categorized by the direction data flows into or out of Camunda 8.

## Outbound Connectors
## Outbound connectors

Outbound Connectors allow workflows to trigger external systems or services, making it possible to integrate workflows with other parts of a business process or system architecture.
Outbound connectors allow workflows to trigger external systems or services, making it possible to integrate workflows with other parts of a business process or system architecture.

The Java code to connect to the external system is executed when the workflow reaches the service task.

![Outbound Connectors](img/outbound-connectors.png)
![Outbound connectors](img/outbound-connectors.png)

Use outbound Connectors if something needs to happen in the third-party system if a process reaches a service task. For example, calling a REST endpoint or publishing a message to Slack.
Use outbound connectors if something needs to happen in the third-party system if a process reaches a service task. For example, calling a REST endpoint or publishing a message to Slack.

## Inbound Connectors
## Inbound connectors

Inbound Connectors enable workflows to receive data or messages from external systems or services, making it possible to integrate workflows into a wider business process or system architecture.
Inbound Connectors can be used to create a new process instance, or to send a message to a running process instance.
Inbound connectors enable workflows to receive data or messages from external systems or services, making it possible to integrate workflows into a wider business process or system architecture.
Inbound connectors can be used to create a new process instance, or to send a message to a running process instance.

The Java code of the inbound Connector has a lifecycle suitable for long-running operations, such as listening for messages on a queue or waiting for a webhook to be called.
The Connector code is **activated** as soon as the Connector Runtime detects an element in a process definition that references an inbound Connector. It gets `deactivated` in case of an updated or deleted process definition.
The Java code of the inbound connector has a lifecycle suitable for long-running operations, such as listening for messages on a queue or waiting for a webhook to be called.
The connector code is **activated** as soon as the connector Runtime detects an element in a process definition that references an inbound connector. It gets `deactivated` in case of an updated or deleted process definition.

Inbound Connector instances are linked to process definitions and not to specific process instances. If a process definition contains an element referencing an inbound Connector, the Connector code will be first executed when the process definition is deployed and the deployment has been detected by the Connector Runtime.
The Connector object created during deployment will be kept active as long as the process is deployed, and it is reused to serve all instances of the process.
When the process definition is deleted or replaced with a newer version, the Connector object will be removed or updated as well.
Inbound connector instances are linked to process definitions and not to specific process instances. If a process definition contains an element referencing an inbound connector, the connector code will be first executed when the process definition is deployed and the deployment has been detected by the connector Runtime.
The connector object created during deployment will be kept active as long as the process is deployed, and it is reused to serve all instances of the process.
When the process definition is deleted or replaced with a newer version, the connector object will be removed or updated as well.

:::note
Inbound Connectors currently rely on [Operate](../../operate/operate-introduction) API to retrieve the information about deployed process definitions.
Inbound connectors currently rely on [Operate](../../operate/operate-introduction) API to retrieve the information about deployed process definitions.

If your Camunda 8 installation doesn't include Operate, you can only use outbound Connectors.
If your Camunda 8 installation doesn't include Operate, you can only use outbound connectors.
:::

![Inbound Connectors](img/inbound-connectors.png)
![Inbound connectors](img/inbound-connectors.png)

Use inbound Connectors if something needs to happen within the workflow engine because of an external event in the third-party system. For example, because a Slack message was published, or a REST endpoint is called.
Use inbound connectors if something needs to happen within the workflow engine because of an external event in the third-party system. For example, because a Slack message was published, or a REST endpoint is called.

There are three types of inbound Connectors:
There are three types of inbound connectors:

1. **Webhook Connector**: An inbound Connector which creates a webhook for a Camunda workflow.
2. **Subscription Connector**: An inbound Connector that subscribes to a message queue.
3. **Polling Connector**: An inbound Connector that periodically polls an external system or service for new data using HTTP polling.
1. **Webhook connector**: An inbound connector which creates a webhook for a Camunda workflow.
2. **Subscription connector**: An inbound connector that subscribes to a message queue.
3. **Polling connector**: An inbound connector that periodically polls an external system or service for new data using HTTP polling.

## Protocol Connectors
## Protocol connectors

Protocol Connectors can serve as either inbound or outbound Connectors, supporting a variety of technical protocols. These connectors are highly generic, designed to provide a flexible and customizable means of integrating with external systems and services.
Protocol connectors can serve as either inbound or outbound connectors, supporting a variety of technical protocols. These connectors are highly generic, designed to provide a flexible and customizable means of integrating with external systems and services.

Protocol Connectors can be customized to meet the needs of specific use cases using configurable [Connector Templates](manage-connector-templates.md), with no additional coding or deployment required. Examples of protocol Connectors include HTTP REST, GraphQL, as well as message queue connectors.
Protocol connectors can be customized to meet the needs of specific use cases using configurable [Connector Templates](manage-connector-templates.md), with no additional coding or deployment required. Examples of protocol connectors include HTTP REST, GraphQL, as well as message queue connectors.

## Next steps

Review the current list of [available Connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md).
Review the current list of [available connectors](/components/connectors/out-of-the-box-connectors/available-connectors-overview.md).
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ A connector consists of the actual Java code, and the Modeler user interface.

:::note

- If you are only using prebuilt Connectors in Modeler, you only need to understand how to configure and use a Connector in the Modeler interface via the properties panel on the right side of the screen.
- If you are only using prebuilt connectors in Modeler, you only need to understand how to configure and use a connector in the Modeler interface via the properties panel on the right side of the screen.
- Connector templates are a specific type of [element template](/components/modeler/desktop-modeler/element-templates/about-templates.md), that can also be used when creating custom connectors using the [Connector SDK](connector-sdk.md).

:::
Expand Down
Loading
Loading