Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Heroku Provider
  3. API Docs
  4. app
  5. Webhook
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

heroku.app.Webhook

Explore with Pulumi AI

heroku logo
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

    Provides a Heroku App Webhook.

    Example Usage

    # Create a new Heroku app
resource "heroku_app" "foobar" {
  name = "foobar"
  region = "us"
}

# Add a web-hook for the app
resource "heroku_app_webhook" "foobar_release" {
  app_id  = heroku_app.foobar.id
  level   = "notify"
  url     = "https://example.com/heroku_webhook"
  include = ["api:release"]
}

    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: WebhookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            app_id: Optional[str] = None,
            includes: Optional[Sequence[str]] = None,
            level: Optional[str] = None,
            url: Optional[str] = None,
            authorization: Optional[str] = None,
            secret: Optional[str] = None)
    func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
    public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
    public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

    type: heroku:app: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 Heroku.App.Webhook("webhookResource", new()
{
    AppId = "string",
    Includes = new[]
    {
        "string",
    },
    Level = "string",
    Url = "string",
    Authorization = "string",
    Secret = "string",
});

    example, err := app.NewWebhook(ctx, "webhookResource", &app.WebhookArgs{
	AppId: pulumi.String("string"),
	Includes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Level:         pulumi.String("string"),
	Url:           pulumi.String("string"),
	Authorization: pulumi.String("string"),
	Secret:        pulumi.String("string"),
})

    var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .appId("string")
    .includes("string")
    .level("string")
    .url("string")
    .authorization("string")
    .secret("string")
    .build());

    webhook_resource = heroku.app.Webhook("webhookResource",
    app_id="string",
    includes=["string"],
    level="string",
    url="string",
    authorization="string",
    secret="string")

    const webhookResource = new heroku.app.Webhook("webhookResource", {
    appId: "string",
    includes: ["string"],
    level: "string",
    url: "string",
    authorization: "string",
    secret: "string",
});

    type: heroku:app:Webhook
properties:
    appId: string
    authorization: string
    includes:
        - string
    level: string
    secret: string
    url: 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:

    AppId string
    Heroku app ID (do not use app name)
    Includes List<string>
    List of events to deliver to the webhook.
    Level string
    The webhook level (either notify or sync)
    Url string
    Optional plan configuration.
    Authorization string
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    Secret string
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    AppId string
    Heroku app ID (do not use app name)
    Includes []string
    List of events to deliver to the webhook.
    Level string
    The webhook level (either notify or sync)
    Url string
    Optional plan configuration.
    Authorization string
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    Secret string
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    appId String
    Heroku app ID (do not use app name)
    includes List<String>
    List of events to deliver to the webhook.
    level String
    The webhook level (either notify or sync)
    url String
    Optional plan configuration.
    authorization String
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    secret String
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    appId string
    Heroku app ID (do not use app name)
    includes string[]
    List of events to deliver to the webhook.
    level string
    The webhook level (either notify or sync)
    url string
    Optional plan configuration.
    authorization string
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    secret string
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    app_id str
    Heroku app ID (do not use app name)
    includes Sequence[str]
    List of events to deliver to the webhook.
    level str
    The webhook level (either notify or sync)
    url str
    Optional plan configuration.
    authorization str
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    secret str
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    appId String
    Heroku app ID (do not use app name)
    includes List<String>
    List of events to deliver to the webhook.
    level String
    The webhook level (either notify or sync)
    url String
    Optional plan configuration.
    authorization String
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    secret String
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
        app_id: Optional[str] = None,
        authorization: Optional[str] = None,
        includes: Optional[Sequence[str]] = None,
        level: Optional[str] = None,
        secret: Optional[str] = None,
        url: 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: heroku:app: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:
    AppId string
    Heroku app ID (do not use app name)
    Authorization string
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    Includes List<string>
    List of events to deliver to the webhook.
    Level string
    The webhook level (either notify or sync)
    Secret string
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    Url string
    Optional plan configuration.
    AppId string
    Heroku app ID (do not use app name)
    Authorization string
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    Includes []string
    List of events to deliver to the webhook.
    Level string
    The webhook level (either notify or sync)
    Secret string
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    Url string
    Optional plan configuration.
    appId String
    Heroku app ID (do not use app name)
    authorization String
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    includes List<String>
    List of events to deliver to the webhook.
    level String
    The webhook level (either notify or sync)
    secret String
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    url String
    Optional plan configuration.
    appId string
    Heroku app ID (do not use app name)
    authorization string
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    includes string[]
    List of events to deliver to the webhook.
    level string
    The webhook level (either notify or sync)
    secret string
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    url string
    Optional plan configuration.
    app_id str
    Heroku app ID (do not use app name)
    authorization str
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    includes Sequence[str]
    List of events to deliver to the webhook.
    level str
    The webhook level (either notify or sync)
    secret str
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    url str
    Optional plan configuration.
    appId String
    Heroku app ID (do not use app name)
    authorization String
    Values used in Authorization header. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    includes List<String>
    List of events to deliver to the webhook.
    level String
    The webhook level (either notify or sync)
    secret String
    Value used to sign webhook payloads. Once set, this value cannot be fetched from the Heroku API, but it can be updated.
    url String
    Optional plan configuration.

    Import

    ing

    Existing webhooks can be imported using the combination of the application name or id, a colon, and the webhook name or id, e.g.

    $ terraform import heroku_app_webhook.foobar_release foobar:b85d9224-310b-409b-891e-c903f5a40568

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
    pulumiverse/pulumi-heroku