Port execution agent

Port's execution agent provides you with a secure and convenient way to execute workflow webhook action nodes inside your private network without exposing a public endpoint for Port to contact.

Choose an event transport

Kafka is the default agent transport and requires a dedicated topic from Port support. If your network cannot connect to Kafka, use HTTP polling, which does not require a Kafka topic. Review the polling limitations before choosing this transport, including its lack of support for encrypted user inputs and organization secrets in the payload.

The data flow when using the Port execution agent in a workflow is as follows:

• A workflow run reaches a Webhook action node configured with "agent": true.
• Port sends the node's execution event to your dedicated Kafka topic (or makes it available for polling).
• The execution agent pulls the new event from your Kafka topic or via HTTP polling, and sends it to the URL you specified in the node's configuration.

Configuration

To use the Port execution agent in a workflow, configure a Webhook action node and set the agent field to true:

{
  "identifier": "internal-webhook",
  "title": "Trigger Internal Service",
  "config": {
    "type": "WEBHOOK",
    "agent": true,
    "url": "http://internal-service.local/api/deploy",
    "method": "POST",
    "body": {
      "service": "{{ .outputs.trigger.service }}"
    }
  }
}

When using the execution agent, the url field should point to a service (for example, a REST API) that is accessible by the agent. This is typically a private service running inside your network.

Installation and advanced usage

The Port execution agent is a unified agent used for both self-service actions and workflows. For detailed information on installing the agent, configuring streamers (Kafka vs Polling), and controlling the payload, refer to the Actions Port execution agent documentation.