1. Packages
  2. Fivetran Provider
  3. API Docs
  4. getWebhook
fivetran 1.6.2 published on Thursday, Apr 17, 2025 by fivetran

fivetran.getWebhook

Explore with Pulumi AI

fivetran 1.6.2 published on Thursday, Apr 17, 2025 by fivetran

This data source returns a webhook object.

Example Usage

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

const webhook = fivetran.getWebhook({
    id: "webhook_id",
});
Copy
import pulumi
import pulumi_fivetran as fivetran

webhook = fivetran.get_webhook(id="webhook_id")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.LookupWebhook(ctx, &fivetran.LookupWebhookArgs{
			Id: "webhook_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fivetran = Pulumi.Fivetran;

return await Deployment.RunAsync(() => 
{
    var webhook = Fivetran.GetWebhook.Invoke(new()
    {
        Id = "webhook_id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.FivetranFunctions;
import com.pulumi.fivetran.inputs.GetWebhookArgs;
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) {
        final var webhook = FivetranFunctions.getWebhook(GetWebhookArgs.builder()
            .id("webhook_id")
            .build());

    }
}
Copy
variables:
  webhook:
    fn::invoke:
      function: fivetran:getWebhook
      arguments:
        id: webhook_id
Copy

Using getWebhook

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWebhook(args: GetWebhookArgs, opts?: InvokeOptions): Promise<GetWebhookResult>
function getWebhookOutput(args: GetWebhookOutputArgs, opts?: InvokeOptions): Output<GetWebhookResult>
Copy
def get_webhook(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetWebhookResult
def get_webhook_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetWebhookResult]
Copy
func LookupWebhook(ctx *Context, args *LookupWebhookArgs, opts ...InvokeOption) (*LookupWebhookResult, error)
func LookupWebhookOutput(ctx *Context, args *LookupWebhookOutputArgs, opts ...InvokeOption) LookupWebhookResultOutput
Copy

> Note: This function is named LookupWebhook in the Go SDK.

public static class GetWebhook 
{
    public static Task<GetWebhookResult> InvokeAsync(GetWebhookArgs args, InvokeOptions? opts = null)
    public static Output<GetWebhookResult> Invoke(GetWebhookInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
public static Output<GetWebhookResult> getWebhook(GetWebhookArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: fivetran:index/getWebhook:getWebhook
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The webhook ID
Id This property is required. string
The webhook ID
id This property is required. String
The webhook ID
id This property is required. string
The webhook ID
id This property is required. str
The webhook ID
id This property is required. String
The webhook ID

getWebhook Result

The following output properties are available:

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
Id string
The webhook 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
Id string
The webhook 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
id String
The webhook 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
id string
The webhook 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
id str
The webhook 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
id String
The webhook 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

Package Details

Repository
fivetran fivetran/terraform-provider-fivetran
License
Notes
This Pulumi package is based on the fivetran Terraform Provider.
fivetran 1.6.2 published on Thursday, Apr 17, 2025 by fivetran