Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Port
  3. API Docs
  4. Webhook
Port v2.0.23 published on Tuesday, Oct 1, 2024 by port-labs
port-labs/pulumi-port

port.Webhook

Explore with Pulumi AI

port logo
Port v2.0.23 published on Tuesday, Oct 1, 2024 by port-labs
port-labs/pulumi-port

    Webhook resource

    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",
        },
    },
    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"),
		},
	},
	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")
        .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",
    }],
    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",
    }],
    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
    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)
    Resource lookup is not supported in YAML
    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
    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
    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
    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
    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
    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

    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
    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
    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
    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
    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
    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
    team String
    The team of the entity
    title String
    The title of the entity

    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.0.23 published on Tuesday, Oct 1, 2024 by port-labs
    port-labs/pulumi-port