Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Port
  3. API Docs
  4. Webhook
Port v2.11.0 published on Tuesday, Jul 15, 2025 by port-labs
port-labs/pulumi-port

port.Webhook

Explore with Pulumi AI

port logo
Port v2.11.0 published on Tuesday, Jul 15, 2025 by port-labs
port-labs/pulumi-port

    Webhook resource can be used to create webhooks integrations in Port.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as port from "@pulumi/port";

const author = new port.index.Port_blueprint("author", {
    title: "Author",
    icon: "User",
    identifier: "author",
    properties: {
        stringProps: {
            name: {
                type: "string",
                title: "Name",
            },
        },
    },
});
const team = new port.index.Port_blueprint("team", {
    title: "Team",
    icon: "Team",
    identifier: "team",
    properties: {
        stringProps: {
            name: {
                type: "string",
                title: "Team Name",
            },
        },
    },
});
const microservice = new port.index.Port_blueprint("microservice", {
    title: "TF test microservice",
    icon: "Terraform",
    identifier: "microservice",
    properties: {
        stringProps: {
            url: {
                type: "string",
                title: "URL",
            },
        },
    },
    relations: {
        author: {
            title: "Author",
            target: author.identifier,
        },
        team: {
            title: "Team",
            target: team.identifier,
        },
    },
});
const createPr = new port.index.Port_webhook("createPr", {
    identifier: "pr_webhook",
    title: "Webhook with mixed relations",
    icon: "Terraform",
    enabled: true,
    mappings: [{
        blueprint: microservice.identifier,
        operation: {
            type: "create",
        },
        filter: ".headers.\"x-github-event\" == \"pull_request\"",
        entity: {
            identifier: ".body.pull_request.id | tostring",
            title: ".body.pull_request.title",
            properties: {
                url: ".body.pull_request.html_url",
            },
            relations: {
                author: JSON.stringify({
                    combinator: "'and'",
                    rules: [{
                        property: "'$identifier'",
                        operator: "'='",
                        value: ".body.pull_request.user.login | tostring",
                    }],
                }),
                team: ".body.repository.owner.login | tostring",
            },
        },
    }],
}, {
    dependsOn: [
        microservice,
        author,
        team,
    ],
});

    import pulumi
import json
import pulumi_port as port

author = port.index.Port_blueprint("author",
    title=Author,
    icon=User,
    identifier=author,
    properties={
        stringProps: {
            name: {
                type: string,
                title: Name,
            },
        },
    })
team = port.index.Port_blueprint("team",
    title=Team,
    icon=Team,
    identifier=team,
    properties={
        stringProps: {
            name: {
                type: string,
                title: Team Name,
            },
        },
    })
microservice = port.index.Port_blueprint("microservice",
    title=TF test microservice,
    icon=Terraform,
    identifier=microservice,
    properties={
        stringProps: {
            url: {
                type: string,
                title: URL,
            },
        },
    },
    relations={
        author: {
            title: Author,
            target: author.identifier,
        },
        team: {
            title: Team,
            target: team.identifier,
        },
    })
create_pr = port.index.Port_webhook("createPr",
    identifier=pr_webhook,
    title=Webhook with mixed relations,
    icon=Terraform,
    enabled=True,
    mappings=[{
        blueprint: microservice.identifier,
        operation: {
            type: create,
        },
        filter: .headers."x-github-event" == "pull_request",
        entity: {
            identifier: .body.pull_request.id | tostring,
            title: .body.pull_request.title,
            properties: {
                url: .body.pull_request.html_url,
            },
            relations: {
                author: json.dumps({
                    combinator: 'and',
                    rules: [{
                        property: '$identifier',
                        operator: '=',
                        value: .body.pull_request.user.login | tostring,
                    }],
                }),
                team: .body.repository.owner.login | tostring,
            },
        },
    }],
    opts = pulumi.ResourceOptions(depends_on=[
            microservice,
            author,
            team,
        ]))

    package main

import (
	"encoding/json"

	"github.com/port-labs/pulumi-port/sdk/v2/go/port"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
author, err := port.NewPort_blueprint(ctx, "author", &port.Port_blueprintArgs{
Title: "Author",
Icon: "User",
Identifier: "author",
Properties: map[string]interface{}{
"stringProps": map[string]interface{}{
"name": map[string]interface{}{
"type": "string",
"title": "Name",
},
},
},
})
if err != nil {
return err
}
team, err := port.NewPort_blueprint(ctx, "team", &port.Port_blueprintArgs{
Title: "Team",
Icon: "Team",
Identifier: "team",
Properties: map[string]interface{}{
"stringProps": map[string]interface{}{
"name": map[string]interface{}{
"type": "string",
"title": "Team Name",
},
},
},
})
if err != nil {
return err
}
microservice, err := port.NewPort_blueprint(ctx, "microservice", &port.Port_blueprintArgs{
Title: "TF test microservice",
Icon: "Terraform",
Identifier: "microservice",
Properties: map[string]interface{}{
"stringProps": map[string]interface{}{
"url": map[string]interface{}{
"type": "string",
"title": "URL",
},
},
},
Relations: map[string]interface{}{
"author": map[string]interface{}{
"title": "Author",
"target": author.Identifier,
},
"team": map[string]interface{}{
"title": "Team",
"target": team.Identifier,
},
},
})
if err != nil {
return err
}
_, err = port.NewPort_webhook(ctx, "createPr", &port.Port_webhookArgs{
Identifier: "pr_webhook",
Title: "Webhook with mixed relations",
Icon: "Terraform",
Enabled: true,
Mappings: []map[string]interface{}{
map[string]interface{}{
"blueprint": microservice.Identifier,
"operation": map[string]interface{}{
"type": "create",
},
"filter": ".headers.\"x-github-event\" == \"pull_request\"",
"entity": map[string]interface{}{
"identifier": ".body.pull_request.id | tostring",
"title": ".body.pull_request.title",
"properties": map[string]interface{}{
"url": ".body.pull_request.html_url",
},
"relations": map[string]interface{}{
"author": %!v(PANIC=Format method: fatal: An assertion has failed: unlowered function toJSON),
"team": ".body.repository.owner.login | tostring",
},
},
},
},
}, pulumi.DependsOn([]pulumi.Resource{
microservice,
author,
team,
}))
if err != nil {
return err
}
return nil
})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Port = Pulumi.Port;

return await Deployment.RunAsync(() => 
{
    var author = new Port.Index.Port_blueprint("author", new()
    {
        Title = "Author",
        Icon = "User",
        Identifier = "author",
        Properties = 
        {
            { "stringProps", 
            {
                { "name", 
                {
                    { "type", "string" },
                    { "title", "Name" },
                } },
            } },
        },
    });

    var team = new Port.Index.Port_blueprint("team", new()
    {
        Title = "Team",
        Icon = "Team",
        Identifier = "team",
        Properties = 
        {
            { "stringProps", 
            {
                { "name", 
                {
                    { "type", "string" },
                    { "title", "Team Name" },
                } },
            } },
        },
    });

    var microservice = new Port.Index.Port_blueprint("microservice", new()
    {
        Title = "TF test microservice",
        Icon = "Terraform",
        Identifier = "microservice",
        Properties = 
        {
            { "stringProps", 
            {
                { "url", 
                {
                    { "type", "string" },
                    { "title", "URL" },
                } },
            } },
        },
        Relations = 
        {
            { "author", 
            {
                { "title", "Author" },
                { "target", author.Identifier },
            } },
            { "team", 
            {
                { "title", "Team" },
                { "target", team.Identifier },
            } },
        },
    });

    var createPr = new Port.Index.Port_webhook("createPr", new()
    {
        Identifier = "pr_webhook",
        Title = "Webhook with mixed relations",
        Icon = "Terraform",
        Enabled = true,
        Mappings = new[]
        {
            
            {
                { "blueprint", microservice.Identifier },
                { "operation", 
                {
                    { "type", "create" },
                } },
                { "filter", ".headers.\"x-github-event\" == \"pull_request\"" },
                { "entity", 
                {
                    { "identifier", ".body.pull_request.id | tostring" },
                    { "title", ".body.pull_request.title" },
                    { "properties", 
                    {
                        { "url", ".body.pull_request.html_url" },
                    } },
                    { "relations", 
                    {
                        { "author", JsonSerializer.Serialize(new Dictionary<string, object?>
                        {
                            ["combinator"] = "'and'",
                            ["rules"] = new[]
                            {
                                new Dictionary<string, object?>
                                {
                                    ["property"] = "'$identifier'",
                                    ["operator"] = "'='",
                                    ["value"] = ".body.pull_request.user.login | tostring",
                                },
                            },
                        }) },
                        { "team", ".body.repository.owner.login | tostring" },
                    } },
                } },
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            microservice,
            author,
            team,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.port.port_blueprint;
import com.pulumi.port.Port_blueprintArgs;
import com.pulumi.port.port_webhook;
import com.pulumi.port.Port_webhookArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var author = new Port_blueprint("author", Port_blueprintArgs.builder()
            .title("Author")
            .icon("User")
            .identifier("author")
            .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var team = new Port_blueprint("team", Port_blueprintArgs.builder()
            .title("Team")
            .icon("Team")
            .identifier("team")
            .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var microservice = new Port_blueprint("microservice", Port_blueprintArgs.builder()
            .title("TF test microservice")
            .icon("Terraform")
            .identifier("microservice")
            .properties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .relations(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var createPr = new Port_webhook("createPr", Port_webhookArgs.builder()
            .identifier("pr_webhook")
            .title("Webhook with mixed relations")
            .icon("Terraform")
            .enabled(true)
            .mappings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    microservice,
                    author,
                    team)
                .build());

    }
}

    resources:
  author:
    type: port:port_blueprint
    properties:
      title: Author
      icon: User
      identifier: author
      properties:
        stringProps:
          name:
            type: string
            title: Name
  team:
    type: port:port_blueprint
    properties:
      title: Team
      icon: Team
      identifier: team
      properties:
        stringProps:
          name:
            type: string
            title: Team Name
  microservice:
    type: port:port_blueprint
    properties:
      title: TF test microservice
      icon: Terraform
      identifier: microservice
      properties:
        stringProps:
          url:
            type: string
            title: URL
      relations:
        author:
          title: Author
          target: ${author.identifier}
        team:
          title: Team
          target: ${team.identifier}
  createPr:
    type: port:port_webhook
    properties:
      identifier: pr_webhook
      title: Webhook with mixed relations
      icon: Terraform
      enabled: true
      mappings:
        - blueprint: ${microservice.identifier}
          operation:
            type: create
          filter: .headers."x-github-event" == "pull_request"
          entity:
            identifier: .body.pull_request.id | tostring
            title: .body.pull_request.title
            properties:
              url: .body.pull_request.html_url
            relations:
              author:
                fn::toJSON:
                  combinator: '''and'''
                  rules:
                    - property: '''$identifier'''
                      operator: '''='''
                      value: .body.pull_request.user.login | tostring
              team: .body.repository.owner.login | tostring
    options:
      dependsOn:
        - ${microservice}
        - ${author}
        - ${team}

    Notes

    • When using object format for relations, combinator, property and operator fields should be enclosed in single quotes, while value should not have quotes as it’s a JQ expression. The single quotes are required because these fields contain literal string values that must be passed as-is to the Port API, whereas value contains a JQ expression that should be evaluated dynamically.
    • For all available operators, see the Port comparison operators documentation.

    Create Webhook Resource

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

    Constructor syntax

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

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            icon: Optional[str] = None,
            identifier: Optional[str] = None,
            mappings: Optional[Sequence[WebhookMappingArgs]] = None,
            security: Optional[WebhookSecurityArgs] = None,
            title: Optional[str] = None)
    func NewWebhook(ctx *Context, name string, args *WebhookArgs, opts ...ResourceOption) (*Webhook, error)
    public Webhook(string name, WebhookArgs? args = null, CustomResourceOptions? opts = null)
    public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args WebhookArgs
    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 WebhookArgs
    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 WebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhookArgs
    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 webhookResource = new Port.Webhook("webhookResource", new()
{
    Description = "string",
    Enabled = false,
    Icon = "string",
    Identifier = "string",
    Mappings = new[]
    {
        new Port.Inputs.WebhookMappingArgs
        {
            Blueprint = "string",
            Entity = new Port.Inputs.WebhookMappingEntityArgs
            {
                Identifier = "string",
                Icon = "string",
                Properties = 
                {
                    { "string", "string" },
                },
                Relations = 
                {
                    { "string", "string" },
                },
                Team = "string",
                Title = "string",
            },
            Filter = "string",
            ItemsToParse = "string",
            Operation = new Port.Inputs.WebhookMappingOperationArgs
            {
                Type = "string",
                DeleteDependents = false,
            },
        },
    },
    Security = new Port.Inputs.WebhookSecurityArgs
    {
        RequestIdentifierPath = "string",
        Secret = "string",
        SignatureAlgorithm = "string",
        SignatureHeaderName = "string",
        SignaturePrefix = "string",
    },
    Title = "string",
});

    example, err := port.NewWebhook(ctx, "webhookResource", &port.WebhookArgs{
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Icon:        pulumi.String("string"),
	Identifier:  pulumi.String("string"),
	Mappings: port.WebhookMappingArray{
		&port.WebhookMappingArgs{
			Blueprint: pulumi.String("string"),
			Entity: &port.WebhookMappingEntityArgs{
				Identifier: pulumi.String("string"),
				Icon:       pulumi.String("string"),
				Properties: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				Relations: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				Team:  pulumi.String("string"),
				Title: pulumi.String("string"),
			},
			Filter:       pulumi.String("string"),
			ItemsToParse: pulumi.String("string"),
			Operation: &port.WebhookMappingOperationArgs{
				Type:             pulumi.String("string"),
				DeleteDependents: pulumi.Bool(false),
			},
		},
	},
	Security: &port.WebhookSecurityArgs{
		RequestIdentifierPath: pulumi.String("string"),
		Secret:                pulumi.String("string"),
		SignatureAlgorithm:    pulumi.String("string"),
		SignatureHeaderName:   pulumi.String("string"),
		SignaturePrefix:       pulumi.String("string"),
	},
	Title: pulumi.String("string"),
})

    var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .description("string")
    .enabled(false)
    .icon("string")
    .identifier("string")
    .mappings(WebhookMappingArgs.builder()
        .blueprint("string")
        .entity(WebhookMappingEntityArgs.builder()
            .identifier("string")
            .icon("string")
            .properties(Map.of("string", "string"))
            .relations(Map.of("string", "string"))
            .team("string")
            .title("string")
            .build())
        .filter("string")
        .itemsToParse("string")
        .operation(WebhookMappingOperationArgs.builder()
            .type("string")
            .deleteDependents(false)
            .build())
        .build())
    .security(WebhookSecurityArgs.builder()
        .requestIdentifierPath("string")
        .secret("string")
        .signatureAlgorithm("string")
        .signatureHeaderName("string")
        .signaturePrefix("string")
        .build())
    .title("string")
    .build());

    webhook_resource = port.Webhook("webhookResource",
    description="string",
    enabled=False,
    icon="string",
    identifier="string",
    mappings=[{
        "blueprint": "string",
        "entity": {
            "identifier": "string",
            "icon": "string",
            "properties": {
                "string": "string",
            },
            "relations": {
                "string": "string",
            },
            "team": "string",
            "title": "string",
        },
        "filter": "string",
        "items_to_parse": "string",
        "operation": {
            "type": "string",
            "delete_dependents": False,
        },
    }],
    security={
        "request_identifier_path": "string",
        "secret": "string",
        "signature_algorithm": "string",
        "signature_header_name": "string",
        "signature_prefix": "string",
    },
    title="string")

    const webhookResource = new port.Webhook("webhookResource", {
    description: "string",
    enabled: false,
    icon: "string",
    identifier: "string",
    mappings: [{
        blueprint: "string",
        entity: {
            identifier: "string",
            icon: "string",
            properties: {
                string: "string",
            },
            relations: {
                string: "string",
            },
            team: "string",
            title: "string",
        },
        filter: "string",
        itemsToParse: "string",
        operation: {
            type: "string",
            deleteDependents: false,
        },
    }],
    security: {
        requestIdentifierPath: "string",
        secret: "string",
        signatureAlgorithm: "string",
        signatureHeaderName: "string",
        signaturePrefix: "string",
    },
    title: "string",
});

    type: port:Webhook
properties:
    description: string
    enabled: false
    icon: string
    identifier: string
    mappings:
        - blueprint: string
          entity:
            icon: string
            identifier: string
            properties:
                string: string
            relations:
                string: string
            team: string
            title: string
          filter: string
          itemsToParse: string
          operation:
            deleteDependents: false
            type: string
    security:
        requestIdentifierPath: string
        secret: string
        signatureAlgorithm: string
        signatureHeaderName: string
        signaturePrefix: string
    title: string

    Webhook 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 Webhook resource accepts the following input properties:

    Description string
    The description of the webhook
    Enabled bool
    Whether the webhook is enabled
    Icon string
    The icon of the webhook
    Identifier string
    The identifier of the webhook
    Mappings List<port_labs.Port.Inputs.WebhookMapping>
    The mappings of the webhook
    Security port_labs.Port.Inputs.WebhookSecurity
    The security of the webhook
    Title string
    The title of the webhook
    Description string
    The description of the webhook
    Enabled bool
    Whether the webhook is enabled
    Icon string
    The icon of the webhook
    Identifier string
    The identifier of the webhook
    Mappings []WebhookMappingArgs
    The mappings of the webhook
    Security WebhookSecurityArgs
    The security of the webhook
    Title string
    The title of the webhook
    description String
    The description of the webhook
    enabled Boolean
    Whether the webhook is enabled
    icon String
    The icon of the webhook
    identifier String
    The identifier of the webhook
    mappings List<WebhookMapping>
    The mappings of the webhook
    security WebhookSecurity
    The security of the webhook
    title String
    The title of the webhook
    description string
    The description of the webhook
    enabled boolean
    Whether the webhook is enabled
    icon string
    The icon of the webhook
    identifier string
    The identifier of the webhook
    mappings WebhookMapping[]
    The mappings of the webhook
    security WebhookSecurity
    The security of the webhook
    title string
    The title of the webhook
    description str
    The description of the webhook
    enabled bool
    Whether the webhook is enabled
    icon str
    The icon of the webhook
    identifier str
    The identifier of the webhook
    mappings Sequence[WebhookMappingArgs]
    The mappings of the webhook
    security WebhookSecurityArgs
    The security of the webhook
    title str
    The title of the webhook
    description String
    The description of the webhook
    enabled Boolean
    Whether the webhook is enabled
    icon String
    The icon of the webhook
    identifier String
    The identifier of the webhook
    mappings List<Property Map>
    The mappings of the webhook
    security Property Map
    The security of the webhook
    title String
    The title of the webhook

    Outputs

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

    CreatedAt string
    The creation date of the webhook
    CreatedBy string
    The creator of the webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The last update date of the webhook
    UpdatedBy string
    The last updater of the webhook
    Url string
    The url of the webhook
    WebhookKey string
    The webhook key of the webhook
    CreatedAt string
    The creation date of the webhook
    CreatedBy string
    The creator of the webhook
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The last update date of the webhook
    UpdatedBy string
    The last updater of the webhook
    Url string
    The url of the webhook
    WebhookKey string
    The webhook key of the webhook
    createdAt String
    The creation date of the webhook
    createdBy String
    The creator of the webhook
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The last update date of the webhook
    updatedBy String
    The last updater of the webhook
    url String
    The url of the webhook
    webhookKey String
    The webhook key of the webhook
    createdAt string
    The creation date of the webhook
    createdBy string
    The creator of the webhook
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The last update date of the webhook
    updatedBy string
    The last updater of the webhook
    url string
    The url of the webhook
    webhookKey string
    The webhook key of the webhook
    created_at str
    The creation date of the webhook
    created_by str
    The creator of the webhook
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The last update date of the webhook
    updated_by str
    The last updater of the webhook
    url str
    The url of the webhook
    webhook_key str
    The webhook key of the webhook
    createdAt String
    The creation date of the webhook
    createdBy String
    The creator of the webhook
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The last update date of the webhook
    updatedBy String
    The last updater of the webhook
    url String
    The url of the webhook
    webhookKey String
    The webhook key of the webhook

    Look up Existing Webhook Resource

    Get an existing Webhook 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?: WebhookState, opts?: CustomResourceOptions): Webhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        icon: Optional[str] = None,
        identifier: Optional[str] = None,
        mappings: Optional[Sequence[WebhookMappingArgs]] = None,
        security: Optional[WebhookSecurityArgs] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None,
        updated_by: Optional[str] = None,
        url: Optional[str] = None,
        webhook_key: Optional[str] = None) -> Webhook
    func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)
    public static Webhook Get(string name, Input<string> id, WebhookState? state, CustomResourceOptions? opts = null)
    public static Webhook get(String name, Output<String> id, WebhookState state, CustomResourceOptions options)
    resources:  _:    type: port:Webhook    get:      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:
    CreatedAt string
    The creation date of the webhook
    CreatedBy string
    The creator of the webhook
    Description string
    The description of the webhook
    Enabled bool
    Whether the webhook is enabled
    Icon string
    The icon of the webhook
    Identifier string
    The identifier of the webhook
    Mappings List<port_labs.Port.Inputs.WebhookMapping>
    The mappings of the webhook
    Security port_labs.Port.Inputs.WebhookSecurity
    The security of the webhook
    Title string
    The title of the webhook
    UpdatedAt string
    The last update date of the webhook
    UpdatedBy string
    The last updater of the webhook
    Url string
    The url of the webhook
    WebhookKey string
    The webhook key of the webhook
    CreatedAt string
    The creation date of the webhook
    CreatedBy string
    The creator of the webhook
    Description string
    The description of the webhook
    Enabled bool
    Whether the webhook is enabled
    Icon string
    The icon of the webhook
    Identifier string
    The identifier of the webhook
    Mappings []WebhookMappingArgs
    The mappings of the webhook
    Security WebhookSecurityArgs
    The security of the webhook
    Title string
    The title of the webhook
    UpdatedAt string
    The last update date of the webhook
    UpdatedBy string
    The last updater of the webhook
    Url string
    The url of the webhook
    WebhookKey string
    The webhook key of the webhook
    createdAt String
    The creation date of the webhook
    createdBy String
    The creator of the webhook
    description String
    The description of the webhook
    enabled Boolean
    Whether the webhook is enabled
    icon String
    The icon of the webhook
    identifier String
    The identifier of the webhook
    mappings List<WebhookMapping>
    The mappings of the webhook
    security WebhookSecurity
    The security of the webhook
    title String
    The title of the webhook
    updatedAt String
    The last update date of the webhook
    updatedBy String
    The last updater of the webhook
    url String
    The url of the webhook
    webhookKey String
    The webhook key of the webhook
    createdAt string
    The creation date of the webhook
    createdBy string
    The creator of the webhook
    description string
    The description of the webhook
    enabled boolean
    Whether the webhook is enabled
    icon string
    The icon of the webhook
    identifier string
    The identifier of the webhook
    mappings WebhookMapping[]
    The mappings of the webhook
    security WebhookSecurity
    The security of the webhook
    title string
    The title of the webhook
    updatedAt string
    The last update date of the webhook
    updatedBy string
    The last updater of the webhook
    url string
    The url of the webhook
    webhookKey string
    The webhook key of the webhook
    created_at str
    The creation date of the webhook
    created_by str
    The creator of the webhook
    description str
    The description of the webhook
    enabled bool
    Whether the webhook is enabled
    icon str
    The icon of the webhook
    identifier str
    The identifier of the webhook
    mappings Sequence[WebhookMappingArgs]
    The mappings of the webhook
    security WebhookSecurityArgs
    The security of the webhook
    title str
    The title of the webhook
    updated_at str
    The last update date of the webhook
    updated_by str
    The last updater of the webhook
    url str
    The url of the webhook
    webhook_key str
    The webhook key of the webhook
    createdAt String
    The creation date of the webhook
    createdBy String
    The creator of the webhook
    description String
    The description of the webhook
    enabled Boolean
    Whether the webhook is enabled
    icon String
    The icon of the webhook
    identifier String
    The identifier of the webhook
    mappings List<Property Map>
    The mappings of the webhook
    security Property Map
    The security of the webhook
    title String
    The title of the webhook
    updatedAt String
    The last update date of the webhook
    updatedBy String
    The last updater of the webhook
    url String
    The url of the webhook
    webhookKey String
    The webhook key of the webhook

    Supporting Types

    WebhookMapping, WebhookMappingArgs

    Blueprint string
    The blueprint of the mapping
    Entity port_labs.Port.Inputs.WebhookMappingEntity
    The entity of the mapping
    Filter string
    The filter of the mapping
    ItemsToParse string
    The items to parser of the mapping
    Operation port_labs.Port.Inputs.WebhookMappingOperation
    The operation of the mapping
    Blueprint string
    The blueprint of the mapping
    Entity WebhookMappingEntity
    The entity of the mapping
    Filter string
    The filter of the mapping
    ItemsToParse string
    The items to parser of the mapping
    Operation WebhookMappingOperation
    The operation of the mapping
    blueprint String
    The blueprint of the mapping
    entity WebhookMappingEntity
    The entity of the mapping
    filter String
    The filter of the mapping
    itemsToParse String
    The items to parser of the mapping
    operation WebhookMappingOperation
    The operation of the mapping
    blueprint string
    The blueprint of the mapping
    entity WebhookMappingEntity
    The entity of the mapping
    filter string
    The filter of the mapping
    itemsToParse string
    The items to parser of the mapping
    operation WebhookMappingOperation
    The operation of the mapping
    blueprint str
    The blueprint of the mapping
    entity WebhookMappingEntity
    The entity of the mapping
    filter str
    The filter of the mapping
    items_to_parse str
    The items to parser of the mapping
    operation WebhookMappingOperation
    The operation of the mapping
    blueprint String
    The blueprint of the mapping
    entity Property Map
    The entity of the mapping
    filter String
    The filter of the mapping
    itemsToParse String
    The items to parser of the mapping
    operation Property Map
    The operation of the mapping

    WebhookMappingEntity, WebhookMappingEntityArgs

    Identifier string
    The identifier of the entity
    Icon string
    The icon of the entity
    Properties Dictionary<string, string>
    The properties of the entity
    Relations Dictionary<string, string>
    The relations of the entity. Relations can be defined as either simple JQ expressions (strings) or search query objects. When using objects, the rules array must be encoded with jsonencode().
    Team string
    The team of the entity
    Title string
    The title of the entity
    Identifier string
    The identifier of the entity
    Icon string
    The icon of the entity
    Properties map[string]string
    The properties of the entity
    Relations map[string]string
    The relations of the entity. Relations can be defined as either simple JQ expressions (strings) or search query objects. When using objects, the rules array must be encoded with jsonencode().
    Team string
    The team of the entity
    Title string
    The title of the entity
    identifier String
    The identifier of the entity
    icon String
    The icon of the entity
    properties Map<String,String>
    The properties of the entity
    relations Map<String,String>
    The relations of the entity. Relations can be defined as either simple JQ expressions (strings) or search query objects. When using objects, the rules array must be encoded with jsonencode().
    team String
    The team of the entity
    title String
    The title of the entity
    identifier string
    The identifier of the entity
    icon string
    The icon of the entity
    properties {[key: string]: string}
    The properties of the entity
    relations {[key: string]: string}
    The relations of the entity. Relations can be defined as either simple JQ expressions (strings) or search query objects. When using objects, the rules array must be encoded with jsonencode().
    team string
    The team of the entity
    title string
    The title of the entity
    identifier str
    The identifier of the entity
    icon str
    The icon of the entity
    properties Mapping[str, str]
    The properties of the entity
    relations Mapping[str, str]
    The relations of the entity. Relations can be defined as either simple JQ expressions (strings) or search query objects. When using objects, the rules array must be encoded with jsonencode().
    team str
    The team of the entity
    title str
    The title of the entity
    identifier String
    The identifier of the entity
    icon String
    The icon of the entity
    properties Map<String>
    The properties of the entity
    relations Map<String>
    The relations of the entity. Relations can be defined as either simple JQ expressions (strings) or search query objects. When using objects, the rules array must be encoded with jsonencode().
    team String
    The team of the entity
    title String
    The title of the entity

    WebhookMappingOperation, WebhookMappingOperationArgs

    Type string
    The type of the operation
    DeleteDependents bool
    Whether to delete dependents entities, only relevant for delete operations
    Type string
    The type of the operation
    DeleteDependents bool
    Whether to delete dependents entities, only relevant for delete operations
    type String
    The type of the operation
    deleteDependents Boolean
    Whether to delete dependents entities, only relevant for delete operations
    type string
    The type of the operation
    deleteDependents boolean
    Whether to delete dependents entities, only relevant for delete operations
    type str
    The type of the operation
    delete_dependents bool
    Whether to delete dependents entities, only relevant for delete operations
    type String
    The type of the operation
    deleteDependents Boolean
    Whether to delete dependents entities, only relevant for delete operations

    WebhookSecurity, WebhookSecurityArgs

    RequestIdentifierPath string
    The request identifier path of the webhook
    Secret string
    The secret of the webhook
    SignatureAlgorithm string
    The signature algorithm of the webhook
    SignatureHeaderName string
    The signature header name of the webhook
    SignaturePrefix string
    The signature prefix of the webhook
    RequestIdentifierPath string
    The request identifier path of the webhook
    Secret string
    The secret of the webhook
    SignatureAlgorithm string
    The signature algorithm of the webhook
    SignatureHeaderName string
    The signature header name of the webhook
    SignaturePrefix string
    The signature prefix of the webhook
    requestIdentifierPath String
    The request identifier path of the webhook
    secret String
    The secret of the webhook
    signatureAlgorithm String
    The signature algorithm of the webhook
    signatureHeaderName String
    The signature header name of the webhook
    signaturePrefix String
    The signature prefix of the webhook
    requestIdentifierPath string
    The request identifier path of the webhook
    secret string
    The secret of the webhook
    signatureAlgorithm string
    The signature algorithm of the webhook
    signatureHeaderName string
    The signature header name of the webhook
    signaturePrefix string
    The signature prefix of the webhook
    request_identifier_path str
    The request identifier path of the webhook
    secret str
    The secret of the webhook
    signature_algorithm str
    The signature algorithm of the webhook
    signature_header_name str
    The signature header name of the webhook
    signature_prefix str
    The signature prefix of the webhook
    requestIdentifierPath String
    The request identifier path of the webhook
    secret String
    The secret of the webhook
    signatureAlgorithm String
    The signature algorithm of the webhook
    signatureHeaderName String
    The signature header name of the webhook
    signaturePrefix String
    The signature prefix of the webhook

    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 v2.11.0 published on Tuesday, Jul 15, 2025 by port-labs
    port-labs/pulumi-port