Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Port
  4. API Docs
  5. Integration
Viewing docs for Port v2.30.0
published on Tuesday, Oct 6, 2026 by port-labs
Schema (JSON)
port-labs/pulumi-port

port.Integration

port logo port logo
Viewing docs for Port v2.30.0
published on Tuesday, Oct 6, 2026 by port-labs
Schema (JSON)
port-labs/pulumi-port

    Create Integration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
    @overload
def Integration(resource_name: str,
                args: IntegrationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                installation_id: Optional[str] = None,
                config: Optional[str] = None,
                create_port_resources_origin: Optional[str] = None,
                installation_app_type: Optional[str] = None,
                installation_type: Optional[str] = None,
                kafka_changelog_destination: Optional[IntegrationKafkaChangelogDestinationArgs] = None,
                spec: Optional[str] = None,
                title: Optional[str] = None,
                version: Optional[str] = None,
                webhook_changelog_destination: Optional[IntegrationWebhookChangelogDestinationArgs] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: port:Integration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "port_integration" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var integrationResource = new Port.Integration("integrationResource", new()
{
    InstallationId = "string",
    Config = "string",
    CreatePortResourcesOrigin = "string",
    InstallationAppType = "string",
    InstallationType = "string",
    KafkaChangelogDestination = new() { },
    Spec = "string",
    Title = "string",
    Version = "string",
    WebhookChangelogDestination = new Port.Inputs.IntegrationWebhookChangelogDestinationArgs
    {
        Url = "string",
        Agent = false,
    },
});

    example, err := port.NewIntegration(ctx, "integrationResource", &port.IntegrationArgs{
	InstallationId:            pulumi.String("string"),
	Config:                    pulumi.String("string"),
	CreatePortResourcesOrigin: pulumi.String("string"),
	InstallationAppType:       pulumi.String("string"),
	InstallationType:          pulumi.String("string"),
	KafkaChangelogDestination: &port.IntegrationKafkaChangelogDestinationArgs{},
	Spec:                      pulumi.String("string"),
	Title:                     pulumi.String("string"),
	Version:                   pulumi.String("string"),
	WebhookChangelogDestination: &port.IntegrationWebhookChangelogDestinationArgs{
		Url:   pulumi.String("string"),
		Agent: pulumi.Bool(false),
	},
})

    resource "port_integration" "integrationResource" {
  lifecycle {
    create_before_destroy = true
  }
  installation_id              = "string"
  config                       = "string"
  create_port_resources_origin = "string"
  installation_app_type        = "string"
  installation_type            = "string"
  kafka_changelog_destination  = {}
  spec                         = "string"
  title                        = "string"
  version                      = "string"
  webhook_changelog_destination = {
    url   = "string"
    agent = false
  }
}

    var integrationResource = new Integration("integrationResource", IntegrationArgs.builder()
    .installationId("string")
    .config("string")
    .createPortResourcesOrigin("string")
    .installationAppType("string")
    .installationType("string")
    .kafkaChangelogDestination(IntegrationKafkaChangelogDestinationArgs.builder()
        .build())
    .spec("string")
    .title("string")
    .version("string")
    .webhookChangelogDestination(IntegrationWebhookChangelogDestinationArgs.builder()
        .url("string")
        .agent(false)
        .build())
    .build());

    integration_resource = port.Integration("integrationResource",
    installation_id="string",
    config="string",
    create_port_resources_origin="string",
    installation_app_type="string",
    installation_type="string",
    kafka_changelog_destination={},
    spec="string",
    title="string",
    version="string",
    webhook_changelog_destination={
        "url": "string",
        "agent": False,
    })

    const integrationResource = new port.Integration("integrationResource", {
    installationId: "string",
    config: "string",
    createPortResourcesOrigin: "string",
    installationAppType: "string",
    installationType: "string",
    kafkaChangelogDestination: {},
    spec: "string",
    title: "string",
    version: "string",
    webhookChangelogDestination: {
        url: "string",
        agent: false,
    },
});

    type: port:Integration
properties:
    config: string
    createPortResourcesOrigin: string
    installationAppType: string
    installationId: string
    installationType: string
    kafkaChangelogDestination: {}
    spec: string
    title: string
    version: string
    webhookChangelogDestination:
        agent: false
        url: string

    Integration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Integration resource accepts the following input properties:

    InstallationId string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    Config string
    CreatePortResourcesOrigin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    InstallationAppType string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    InstallationType string
    KafkaChangelogDestination port_labs.Port.Inputs.IntegrationKafkaChangelogDestination
    The changelog destination of the blueprint (just an empty {})
    Spec string
    Title string
    Version string
    WebhookChangelogDestination port_labs.Port.Inputs.IntegrationWebhookChangelogDestination
    The webhook changelog destination of the integration
    InstallationId string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    Config string
    CreatePortResourcesOrigin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    InstallationAppType string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    InstallationType string
    KafkaChangelogDestination IntegrationKafkaChangelogDestinationArgs
    The changelog destination of the blueprint (just an empty {})
    Spec string
    Title string
    Version string
    WebhookChangelogDestination IntegrationWebhookChangelogDestinationArgs
    The webhook changelog destination of the integration
    installation_id string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    config string
    create_port_resources_origin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installation_app_type string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installation_type string
    kafka_changelog_destination object
    The changelog destination of the blueprint (just an empty {})
    spec string
    title string
    version string
    webhook_changelog_destination object
    The webhook changelog destination of the integration
    installationId String
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    config String
    createPortResourcesOrigin String
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installationAppType String
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installationType String
    kafkaChangelogDestination IntegrationKafkaChangelogDestination
    The changelog destination of the blueprint (just an empty {})
    spec String
    title String
    version String
    webhookChangelogDestination IntegrationWebhookChangelogDestination
    The webhook changelog destination of the integration
    installationId string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    config string
    createPortResourcesOrigin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installationAppType string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installationType string
    kafkaChangelogDestination IntegrationKafkaChangelogDestination
    The changelog destination of the blueprint (just an empty {})
    spec string
    title string
    version string
    webhookChangelogDestination IntegrationWebhookChangelogDestination
    The webhook changelog destination of the integration
    installation_id str
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    config str
    create_port_resources_origin str
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installation_app_type str
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installation_type str
    kafka_changelog_destination IntegrationKafkaChangelogDestinationArgs
    The changelog destination of the blueprint (just an empty {})
    spec str
    title str
    version str
    webhook_changelog_destination IntegrationWebhookChangelogDestinationArgs
    The webhook changelog destination of the integration
    installationId String
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    config String
    createPortResourcesOrigin String
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installationAppType String
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installationType String
    kafkaChangelogDestination Property Map
    The changelog destination of the blueprint (just an empty {})
    spec String
    title String
    version String
    webhookChangelogDestination Property Map
    The webhook changelog destination of the integration

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.

    Look up Existing Integration Resource

    Get an existing Integration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IntegrationState, opts?: CustomResourceOptions): Integration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        create_port_resources_origin: Optional[str] = None,
        installation_app_type: Optional[str] = None,
        installation_id: Optional[str] = None,
        installation_type: Optional[str] = None,
        kafka_changelog_destination: Optional[IntegrationKafkaChangelogDestinationArgs] = None,
        spec: Optional[str] = None,
        status: Optional[str] = None,
        title: Optional[str] = None,
        version: Optional[str] = None,
        webhook_changelog_destination: Optional[IntegrationWebhookChangelogDestinationArgs] = None) -> Integration
    func GetIntegration(ctx *Context, name string, id IDInput, state *IntegrationState, opts ...ResourceOption) (*Integration, error)
    public static Integration Get(string name, Input<string> id, IntegrationState? state, CustomResourceOptions? opts = null)
    public static Integration get(String name, Output<String> id, IntegrationState state, CustomResourceOptions options)
    resources:  _:    type: port:Integration    get:      id: ${id}
    import {
  to = port_integration.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Config string
    CreatePortResourcesOrigin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    InstallationAppType string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    InstallationId string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    InstallationType string
    KafkaChangelogDestination port_labs.Port.Inputs.IntegrationKafkaChangelogDestination
    The changelog destination of the blueprint (just an empty {})
    Spec string
    Status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    Title string
    Version string
    WebhookChangelogDestination port_labs.Port.Inputs.IntegrationWebhookChangelogDestination
    The webhook changelog destination of the integration
    Config string
    CreatePortResourcesOrigin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    InstallationAppType string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    InstallationId string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    InstallationType string
    KafkaChangelogDestination IntegrationKafkaChangelogDestinationArgs
    The changelog destination of the blueprint (just an empty {})
    Spec string
    Status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    Title string
    Version string
    WebhookChangelogDestination IntegrationWebhookChangelogDestinationArgs
    The webhook changelog destination of the integration
    config string
    create_port_resources_origin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installation_app_type string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installation_id string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    installation_type string
    kafka_changelog_destination object
    The changelog destination of the blueprint (just an empty {})
    spec string
    status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    title string
    version string
    webhook_changelog_destination object
    The webhook changelog destination of the integration
    config String
    createPortResourcesOrigin String
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installationAppType String
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installationId String
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    installationType String
    kafkaChangelogDestination IntegrationKafkaChangelogDestination
    The changelog destination of the blueprint (just an empty {})
    spec String
    status String
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    title String
    version String
    webhookChangelogDestination IntegrationWebhookChangelogDestination
    The webhook changelog destination of the integration
    config string
    createPortResourcesOrigin string
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installationAppType string
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installationId string
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    installationType string
    kafkaChangelogDestination IntegrationKafkaChangelogDestination
    The changelog destination of the blueprint (just an empty {})
    spec string
    status string
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    title string
    version string
    webhookChangelogDestination IntegrationWebhookChangelogDestination
    The webhook changelog destination of the integration
    config str
    create_port_resources_origin str
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installation_app_type str
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installation_id str
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    installation_type str
    kafka_changelog_destination IntegrationKafkaChangelogDestinationArgs
    The changelog destination of the blueprint (just an empty {})
    spec str
    status str
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    title str
    version str
    webhook_changelog_destination IntegrationWebhookChangelogDestinationArgs
    The webhook changelog destination of the integration
    config String
    createPortResourcesOrigin String
    Controls whether Port creates default blueprints and mappings when the integration is created. Use Empty to skip default resource creation. Use Port to create default resources via Port. If omitted, default resources are created. Can only be set on creation.
    installationAppType String
    The integrated tool name for catalog integration types (e.g. github-ocean, gitlab, pagerduty). Cannot be changed after creation.
    installationId String
    The installation ID of the integration. Must contain only lowercase letters, numbers, and dashes (pattern: ^[a-z0-9-]+$). Cannot be changed after creation.
    installationType String
    kafkaChangelogDestination Property Map
    The changelog destination of the blueprint (just an empty {})
    spec String
    status String
    The provisioning status of the integration (e.g. Creating, Running, Updating, Error). Relevant for Port Hosted integrations that provision asynchronously.
    title String
    version String
    webhookChangelogDestination Property Map
    The webhook changelog destination of the integration

    Supporting Types

    IntegrationWebhookChangelogDestination, IntegrationWebhookChangelogDestinationArgs

    Url string
    The url of the webhook changelog destination
    Agent bool
    The agent of the webhook changelog destination
    Url string
    The url of the webhook changelog destination
    Agent bool
    The agent of the webhook changelog destination
    url string
    The url of the webhook changelog destination
    agent bool
    The agent of the webhook changelog destination
    url String
    The url of the webhook changelog destination
    agent Boolean
    The agent of the webhook changelog destination
    url string
    The url of the webhook changelog destination
    agent boolean
    The agent of the webhook changelog destination
    url str
    The url of the webhook changelog destination
    agent bool
    The agent of the webhook changelog destination
    url String
    The url of the webhook changelog destination
    agent Boolean
    The agent of the webhook changelog destination

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port-labs Terraform Provider.
    port logo port logo
    Viewing docs for Port v2.30.0
    published on Tuesday, Oct 6, 2026 by port-labs
    Schema (JSON)
    port-labs/pulumi-port

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial