1. Packages
  2. Packages
  3. Thoth
  4. API Docs
  5. governance
  6. WebhookSettings
Viewing docs for Thoth v0.1.15
published on Thursday, Jul 23, 2026 by Aten Security
thoth logo
Viewing docs for Thoth v0.1.15
published on Thursday, Jul 23, 2026 by Aten Security

    Create WebhookSettings Resource

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

    Constructor syntax

    new WebhookSettings(name: string, args?: WebhookSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def WebhookSettings(resource_name: str,
                        args: Optional[WebhookSettingsArgs] = None,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WebhookSettings(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        test_webhook_on_apply: Optional[bool] = None,
                        webhook_enabled: Optional[bool] = None,
                        webhook_secret: Optional[str] = None,
                        webhook_url: Optional[str] = None)
    func NewWebhookSettings(ctx *Context, name string, args *WebhookSettingsArgs, opts ...ResourceOption) (*WebhookSettings, error)
    public WebhookSettings(string name, WebhookSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public WebhookSettings(String name, WebhookSettingsArgs args)
    public WebhookSettings(String name, WebhookSettingsArgs args, CustomResourceOptions options)
    
    type: thoth:governance:WebhookSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "thoth_governance_webhook_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args WebhookSettingsArgs
    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 WebhookSettingsArgs
    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 WebhookSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhookSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhookSettingsArgs
    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 webhookSettingsResource = new Thoth.Governance.WebhookSettings("webhookSettingsResource", new()
    {
        TestWebhookOnApply = false,
        WebhookEnabled = false,
        WebhookSecret = "string",
        WebhookUrl = "string",
    });
    
    example, err := governance.NewWebhookSettings(ctx, "webhookSettingsResource", &governance.WebhookSettingsArgs{
    	TestWebhookOnApply: pulumi.Bool(false),
    	WebhookEnabled:     pulumi.Bool(false),
    	WebhookSecret:      pulumi.String("string"),
    	WebhookUrl:         pulumi.String("string"),
    })
    
    resource "thoth_governance_webhook_settings" "webhookSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      test_webhook_on_apply = false
      webhook_enabled       = false
      webhook_secret        = "string"
      webhook_url           = "string"
    }
    
    var webhookSettingsResource = new WebhookSettings("webhookSettingsResource", WebhookSettingsArgs.builder()
        .testWebhookOnApply(false)
        .webhookEnabled(false)
        .webhookSecret("string")
        .webhookUrl("string")
        .build());
    
    webhook_settings_resource = thoth.governance.WebhookSettings("webhookSettingsResource",
        test_webhook_on_apply=False,
        webhook_enabled=False,
        webhook_secret="string",
        webhook_url="string")
    
    const webhookSettingsResource = new thoth.governance.WebhookSettings("webhookSettingsResource", {
        testWebhookOnApply: false,
        webhookEnabled: false,
        webhookSecret: "string",
        webhookUrl: "string",
    });
    
    type: thoth:governance:WebhookSettings
    properties:
        testWebhookOnApply: false
        webhookEnabled: false
        webhookSecret: string
        webhookUrl: string
    

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

    TestWebhookOnApply bool
    Run webhook test endpoint after applying settings.
    WebhookEnabled bool
    Enable outbound webhook delivery.
    WebhookSecret string
    Webhook signing secret.
    WebhookUrl string
    Outbound webhook URL.
    TestWebhookOnApply bool
    Run webhook test endpoint after applying settings.
    WebhookEnabled bool
    Enable outbound webhook delivery.
    WebhookSecret string
    Webhook signing secret.
    WebhookUrl string
    Outbound webhook URL.
    test_webhook_on_apply bool
    Run webhook test endpoint after applying settings.
    webhook_enabled bool
    Enable outbound webhook delivery.
    webhook_secret string
    Webhook signing secret.
    webhook_url string
    Outbound webhook URL.
    testWebhookOnApply Boolean
    Run webhook test endpoint after applying settings.
    webhookEnabled Boolean
    Enable outbound webhook delivery.
    webhookSecret String
    Webhook signing secret.
    webhookUrl String
    Outbound webhook URL.
    testWebhookOnApply boolean
    Run webhook test endpoint after applying settings.
    webhookEnabled boolean
    Enable outbound webhook delivery.
    webhookSecret string
    Webhook signing secret.
    webhookUrl string
    Outbound webhook URL.
    test_webhook_on_apply bool
    Run webhook test endpoint after applying settings.
    webhook_enabled bool
    Enable outbound webhook delivery.
    webhook_secret str
    Webhook signing secret.
    webhook_url str
    Outbound webhook URL.
    testWebhookOnApply Boolean
    Run webhook test endpoint after applying settings.
    webhookEnabled Boolean
    Enable outbound webhook delivery.
    webhookSecret String
    Webhook signing secret.
    webhookUrl String
    Outbound webhook URL.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TenantId string
    Tenant ID resolved from provider configuration.
    UpdatedAt string
    Last update timestamp returned by GovAPI.
    Id string
    The provider-assigned unique ID for this managed resource.
    TenantId string
    Tenant ID resolved from provider configuration.
    UpdatedAt string
    Last update timestamp returned by GovAPI.
    id string
    The provider-assigned unique ID for this managed resource.
    tenant_id string
    Tenant ID resolved from provider configuration.
    updated_at string
    Last update timestamp returned by GovAPI.
    id String
    The provider-assigned unique ID for this managed resource.
    tenantId String
    Tenant ID resolved from provider configuration.
    updatedAt String
    Last update timestamp returned by GovAPI.
    id string
    The provider-assigned unique ID for this managed resource.
    tenantId string
    Tenant ID resolved from provider configuration.
    updatedAt string
    Last update timestamp returned by GovAPI.
    id str
    The provider-assigned unique ID for this managed resource.
    tenant_id str
    Tenant ID resolved from provider configuration.
    updated_at str
    Last update timestamp returned by GovAPI.
    id String
    The provider-assigned unique ID for this managed resource.
    tenantId String
    Tenant ID resolved from provider configuration.
    updatedAt String
    Last update timestamp returned by GovAPI.

    Look up Existing WebhookSettings Resource

    Get an existing WebhookSettings 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?: WebhookSettingsState, opts?: CustomResourceOptions): WebhookSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            tenant_id: Optional[str] = None,
            test_webhook_on_apply: Optional[bool] = None,
            updated_at: Optional[str] = None,
            webhook_enabled: Optional[bool] = None,
            webhook_secret: Optional[str] = None,
            webhook_url: Optional[str] = None) -> WebhookSettings
    func GetWebhookSettings(ctx *Context, name string, id IDInput, state *WebhookSettingsState, opts ...ResourceOption) (*WebhookSettings, error)
    public static WebhookSettings Get(string name, Input<string> id, WebhookSettingsState? state, CustomResourceOptions? opts = null)
    public static WebhookSettings get(String name, Output<String> id, WebhookSettingsState state, CustomResourceOptions options)
    resources:  _:    type: thoth:governance:WebhookSettings    get:      id: ${id}
    import {
      to = thoth_governance_webhook_settings.example
      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:
    TenantId string
    Tenant ID resolved from provider configuration.
    TestWebhookOnApply bool
    Run webhook test endpoint after applying settings.
    UpdatedAt string
    Last update timestamp returned by GovAPI.
    WebhookEnabled bool
    Enable outbound webhook delivery.
    WebhookSecret string
    Webhook signing secret.
    WebhookUrl string
    Outbound webhook URL.
    TenantId string
    Tenant ID resolved from provider configuration.
    TestWebhookOnApply bool
    Run webhook test endpoint after applying settings.
    UpdatedAt string
    Last update timestamp returned by GovAPI.
    WebhookEnabled bool
    Enable outbound webhook delivery.
    WebhookSecret string
    Webhook signing secret.
    WebhookUrl string
    Outbound webhook URL.
    tenant_id string
    Tenant ID resolved from provider configuration.
    test_webhook_on_apply bool
    Run webhook test endpoint after applying settings.
    updated_at string
    Last update timestamp returned by GovAPI.
    webhook_enabled bool
    Enable outbound webhook delivery.
    webhook_secret string
    Webhook signing secret.
    webhook_url string
    Outbound webhook URL.
    tenantId String
    Tenant ID resolved from provider configuration.
    testWebhookOnApply Boolean
    Run webhook test endpoint after applying settings.
    updatedAt String
    Last update timestamp returned by GovAPI.
    webhookEnabled Boolean
    Enable outbound webhook delivery.
    webhookSecret String
    Webhook signing secret.
    webhookUrl String
    Outbound webhook URL.
    tenantId string
    Tenant ID resolved from provider configuration.
    testWebhookOnApply boolean
    Run webhook test endpoint after applying settings.
    updatedAt string
    Last update timestamp returned by GovAPI.
    webhookEnabled boolean
    Enable outbound webhook delivery.
    webhookSecret string
    Webhook signing secret.
    webhookUrl string
    Outbound webhook URL.
    tenant_id str
    Tenant ID resolved from provider configuration.
    test_webhook_on_apply bool
    Run webhook test endpoint after applying settings.
    updated_at str
    Last update timestamp returned by GovAPI.
    webhook_enabled bool
    Enable outbound webhook delivery.
    webhook_secret str
    Webhook signing secret.
    webhook_url str
    Outbound webhook URL.
    tenantId String
    Tenant ID resolved from provider configuration.
    testWebhookOnApply Boolean
    Run webhook test endpoint after applying settings.
    updatedAt String
    Last update timestamp returned by GovAPI.
    webhookEnabled Boolean
    Enable outbound webhook delivery.
    webhookSecret String
    Webhook signing secret.
    webhookUrl String
    Outbound webhook URL.

    Package Details

    Repository
    thoth atensecurity/pulumi-thoth
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the thoth Terraform Provider.
    thoth logo
    Viewing docs for Thoth v0.1.15
    published on Thursday, Jul 23, 2026 by Aten Security

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial