Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. Webhook
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.Webhook

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

    This resource allows you to create, update, and delete webhooks.

    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,
            active: Optional[bool] = None,
            events: Optional[Sequence[str]] = None,
            secret: Optional[str] = None,
            type: Optional[str] = None,
            url: Optional[str] = None,
            group_id: Optional[str] = None,
            run_tests: Optional[bool] = 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: fivetran: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 Fivetran.Webhook("webhookResource", new()
{
    Active = false,
    Events = new[]
    {
        "string",
    },
    Secret = "string",
    Type = "string",
    Url = "string",
    GroupId = "string",
    RunTests = false,
});

    example, err := fivetran.NewWebhook(ctx, "webhookResource", &fivetran.WebhookArgs{
Active: pulumi.Bool(false),
Events: pulumi.StringArray{
pulumi.String("string"),
},
Secret: pulumi.String("string"),
Type: pulumi.String("string"),
Url: pulumi.String("string"),
GroupId: pulumi.String("string"),
RunTests: pulumi.Bool(false),
})

    var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .active(false)
    .events("string")
    .secret("string")
    .type("string")
    .url("string")
    .groupId("string")
    .runTests(false)
    .build());

    webhook_resource = fivetran.Webhook("webhookResource",
    active=False,
    events=["string"],
    secret="string",
    type="string",
    url="string",
    group_id="string",
    run_tests=False)

    const webhookResource = new fivetran.Webhook("webhookResource", {
    active: false,
    events: ["string"],
    secret: "string",
    type: "string",
    url: "string",
    groupId: "string",
    runTests: false,
});

    type: fivetran:Webhook
properties:
    active: false
    events:
        - string
    groupId: string
    runTests: false
    secret: string
    type: 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:

    Active bool
    Boolean, if set to true, webhooks are immediately sent in response to events
    Events List<string>
    The array of event types
    Secret string
    The secret string used for payload signing and masked in the response.
    Type string
    The webhook type (group, account)
    Url string
    Your webhooks URL endpoint for your application
    GroupId string
    The group ID
    RunTests bool
    Specifies whether the setup tests should be run
    Active bool
    Boolean, if set to true, webhooks are immediately sent in response to events
    Events []string
    The array of event types
    Secret string
    The secret string used for payload signing and masked in the response.
    Type string
    The webhook type (group, account)
    Url string
    Your webhooks URL endpoint for your application
    GroupId string
    The group ID
    RunTests bool
    Specifies whether the setup tests should be run
    active Boolean
    Boolean, if set to true, webhooks are immediately sent in response to events
    events List<String>
    The array of event types
    secret String
    The secret string used for payload signing and masked in the response.
    type String
    The webhook type (group, account)
    url String
    Your webhooks URL endpoint for your application
    groupId String
    The group ID
    runTests Boolean
    Specifies whether the setup tests should be run
    active boolean
    Boolean, if set to true, webhooks are immediately sent in response to events
    events string[]
    The array of event types
    secret string
    The secret string used for payload signing and masked in the response.
    type string
    The webhook type (group, account)
    url string
    Your webhooks URL endpoint for your application
    groupId string
    The group ID
    runTests boolean
    Specifies whether the setup tests should be run
    active bool
    Boolean, if set to true, webhooks are immediately sent in response to events
    events Sequence[str]
    The array of event types
    secret str
    The secret string used for payload signing and masked in the response.
    type str
    The webhook type (group, account)
    url str
    Your webhooks URL endpoint for your application
    group_id str
    The group ID
    run_tests bool
    Specifies whether the setup tests should be run
    active Boolean
    Boolean, if set to true, webhooks are immediately sent in response to events
    events List<String>
    The array of event types
    secret String
    The secret string used for payload signing and masked in the response.
    type String
    The webhook type (group, account)
    url String
    Your webhooks URL endpoint for your application
    groupId String
    The group ID
    runTests Boolean
    Specifies whether the setup tests should be run

    Outputs

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

    CreatedAt string
    The webhook creation timestamp
    CreatedBy string
    The ID of the user who created the webhook.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    The webhook creation timestamp
    CreatedBy string
    The ID of the user who created the webhook.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The webhook creation timestamp
    createdBy String
    The ID of the user who created the webhook.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    The webhook creation timestamp
    createdBy string
    The ID of the user who created the webhook.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    The webhook creation timestamp
    created_by str
    The ID of the user who created the webhook.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The webhook creation timestamp
    createdBy String
    The ID of the user who created the webhook.
    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,
        active: Optional[bool] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        events: Optional[Sequence[str]] = None,
        group_id: Optional[str] = None,
        run_tests: Optional[bool] = None,
        secret: Optional[str] = None,
        type: 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: fivetran: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:
    Active bool
    Boolean, if set to true, webhooks are immediately sent in response to events
    CreatedAt string
    The webhook creation timestamp
    CreatedBy string
    The ID of the user who created the webhook.
    Events List<string>
    The array of event types
    GroupId string
    The group ID
    RunTests bool
    Specifies whether the setup tests should be run
    Secret string
    The secret string used for payload signing and masked in the response.
    Type string
    The webhook type (group, account)
    Url string
    Your webhooks URL endpoint for your application
    Active bool
    Boolean, if set to true, webhooks are immediately sent in response to events
    CreatedAt string
    The webhook creation timestamp
    CreatedBy string
    The ID of the user who created the webhook.
    Events []string
    The array of event types
    GroupId string
    The group ID
    RunTests bool
    Specifies whether the setup tests should be run
    Secret string
    The secret string used for payload signing and masked in the response.
    Type string
    The webhook type (group, account)
    Url string
    Your webhooks URL endpoint for your application
    active Boolean
    Boolean, if set to true, webhooks are immediately sent in response to events
    createdAt String
    The webhook creation timestamp
    createdBy String
    The ID of the user who created the webhook.
    events List<String>
    The array of event types
    groupId String
    The group ID
    runTests Boolean
    Specifies whether the setup tests should be run
    secret String
    The secret string used for payload signing and masked in the response.
    type String
    The webhook type (group, account)
    url String
    Your webhooks URL endpoint for your application
    active boolean
    Boolean, if set to true, webhooks are immediately sent in response to events
    createdAt string
    The webhook creation timestamp
    createdBy string
    The ID of the user who created the webhook.
    events string[]
    The array of event types
    groupId string
    The group ID
    runTests boolean
    Specifies whether the setup tests should be run
    secret string
    The secret string used for payload signing and masked in the response.
    type string
    The webhook type (group, account)
    url string
    Your webhooks URL endpoint for your application
    active bool
    Boolean, if set to true, webhooks are immediately sent in response to events
    created_at str
    The webhook creation timestamp
    created_by str
    The ID of the user who created the webhook.
    events Sequence[str]
    The array of event types
    group_id str
    The group ID
    run_tests bool
    Specifies whether the setup tests should be run
    secret str
    The secret string used for payload signing and masked in the response.
    type str
    The webhook type (group, account)
    url str
    Your webhooks URL endpoint for your application
    active Boolean
    Boolean, if set to true, webhooks are immediately sent in response to events
    createdAt String
    The webhook creation timestamp
    createdBy String
    The ID of the user who created the webhook.
    events List<String>
    The array of event types
    groupId String
    The group ID
    runTests Boolean
    Specifies whether the setup tests should be run
    secret String
    The secret string used for payload signing and masked in the response.
    type String
    The webhook type (group, account)
    url String
    Your webhooks URL endpoint for your application

    Import

    1. To import an existing fivetran_webhook resource into your Terraform state, you need to get webhook_id.

    You can retrieve all webhooks using the fivetran_webhooks data source.

    1. Define an empty resource in your .tf configuration:

    hcl

    resource “fivetran_webhook” “my_imported_fivetran_webhook” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/webhook:Webhook my_imported_fivetran_webhook {webhook_id}
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_webhook.my_imported_fivetran_webhook’

    1. Copy the values and paste them to your .tf configuration.

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

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
    fivetran/terraform-provider-fivetran