Docs Home
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootly.WebhooksEndpoint
Explore with Pulumi AI
Create WebhooksEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WebhooksEndpoint(name: string, args: WebhooksEndpointArgs, opts?: CustomResourceOptions);@overload
def WebhooksEndpoint(resource_name: str,
args: WebhooksEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WebhooksEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
url: Optional[str] = None,
enabled: Optional[bool] = None,
event_types: Optional[Sequence[str]] = None,
name: Optional[str] = None,
secret: Optional[str] = None,
slug: Optional[str] = None)func NewWebhooksEndpoint(ctx *Context, name string, args WebhooksEndpointArgs, opts ...ResourceOption) (*WebhooksEndpoint, error)public WebhooksEndpoint(string name, WebhooksEndpointArgs args, CustomResourceOptions? opts = null)public WebhooksEndpoint(String name, WebhooksEndpointArgs args)
public WebhooksEndpoint(String name, WebhooksEndpointArgs args, CustomResourceOptions options)
type: rootly:WebhooksEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. WebhooksEndpointArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. WebhooksEndpointArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. WebhooksEndpointArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. WebhooksEndpointArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. WebhooksEndpointArgs - 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 webhooksEndpointResource = new Rootly.WebhooksEndpoint("webhooksEndpointResource", new()
{
Url = "string",
Enabled = false,
EventTypes = new[]
{
"string",
},
Name = "string",
Secret = "string",
Slug = "string",
});
example, err := rootly.NewWebhooksEndpoint(ctx, "webhooksEndpointResource", &rootly.WebhooksEndpointArgs{
Url: pulumi.String("string"),
Enabled: pulumi.Bool(false),
EventTypes: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Secret: pulumi.String("string"),
Slug: pulumi.String("string"),
})
var webhooksEndpointResource = new WebhooksEndpoint("webhooksEndpointResource", WebhooksEndpointArgs.builder()
.url("string")
.enabled(false)
.eventTypes("string")
.name("string")
.secret("string")
.slug("string")
.build());
webhooks_endpoint_resource = rootly.WebhooksEndpoint("webhooksEndpointResource",
url="string",
enabled=False,
event_types=["string"],
name="string",
secret="string",
slug="string")
const webhooksEndpointResource = new rootly.WebhooksEndpoint("webhooksEndpointResource", {
url: "string",
enabled: false,
eventTypes: ["string"],
name: "string",
secret: "string",
slug: "string",
});
type: rootly:WebhooksEndpoint
properties:
enabled: false
eventTypes:
- string
name: string
secret: string
slug: string
url: string
WebhooksEndpoint 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 WebhooksEndpoint resource accepts the following input properties:
- Url
This property is required. string - The URL of the endpoint.
- Enabled bool
- Event
Types List<string> - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - Name string
- The name of the endpoint
- Secret string
- The webhook signing secret used to verify webhook requests.
- Slug string
- The slug of the endpoint
- Url
This property is required. string - The URL of the endpoint.
- Enabled bool
- Event
Types []string - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - Name string
- The name of the endpoint
- Secret string
- The webhook signing secret used to verify webhook requests.
- Slug string
- The slug of the endpoint
- url
This property is required. String - The URL of the endpoint.
- enabled Boolean
- event
Types List<String> - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name String
- The name of the endpoint
- secret String
- The webhook signing secret used to verify webhook requests.
- slug String
- The slug of the endpoint
- url
This property is required. string - The URL of the endpoint.
- enabled boolean
- event
Types string[] - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name string
- The name of the endpoint
- secret string
- The webhook signing secret used to verify webhook requests.
- slug string
- The slug of the endpoint
- url
This property is required. str - The URL of the endpoint.
- enabled bool
- event_
types Sequence[str] - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name str
- The name of the endpoint
- secret str
- The webhook signing secret used to verify webhook requests.
- slug str
- The slug of the endpoint
- url
This property is required. String - The URL of the endpoint.
- enabled Boolean
- event
Types List<String> - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name String
- The name of the endpoint
- secret String
- The webhook signing secret used to verify webhook requests.
- slug String
- The slug of the endpoint
Outputs
All input properties are implicitly available as output properties. Additionally, the WebhooksEndpoint 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 WebhooksEndpoint Resource
Get an existing WebhooksEndpoint 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?: WebhooksEndpointState, opts?: CustomResourceOptions): WebhooksEndpoint@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
event_types: Optional[Sequence[str]] = None,
name: Optional[str] = None,
secret: Optional[str] = None,
slug: Optional[str] = None,
url: Optional[str] = None) -> WebhooksEndpointfunc GetWebhooksEndpoint(ctx *Context, name string, id IDInput, state *WebhooksEndpointState, opts ...ResourceOption) (*WebhooksEndpoint, error)public static WebhooksEndpoint Get(string name, Input<string> id, WebhooksEndpointState? state, CustomResourceOptions? opts = null)public static WebhooksEndpoint get(String name, Output<String> id, WebhooksEndpointState state, CustomResourceOptions options)resources: _: type: rootly:WebhooksEndpoint get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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
This property is required. - The unique name of the resulting resource.
- id
This property is required. - 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:
- Enabled bool
- Event
Types List<string> - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - Name string
- The name of the endpoint
- Secret string
- The webhook signing secret used to verify webhook requests.
- Slug string
- The slug of the endpoint
- Url string
- The URL of the endpoint.
- Enabled bool
- Event
Types []string - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - Name string
- The name of the endpoint
- Secret string
- The webhook signing secret used to verify webhook requests.
- Slug string
- The slug of the endpoint
- Url string
- The URL of the endpoint.
- enabled Boolean
- event
Types List<String> - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name String
- The name of the endpoint
- secret String
- The webhook signing secret used to verify webhook requests.
- slug String
- The slug of the endpoint
- url String
- The URL of the endpoint.
- enabled boolean
- event
Types string[] - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name string
- The name of the endpoint
- secret string
- The webhook signing secret used to verify webhook requests.
- slug string
- The slug of the endpoint
- url string
- The URL of the endpoint.
- enabled bool
- event_
types Sequence[str] - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name str
- The name of the endpoint
- secret str
- The webhook signing secret used to verify webhook requests.
- slug str
- The slug of the endpoint
- url str
- The URL of the endpoint.
- enabled Boolean
- event
Types List<String> - Value must be one of
incident.created,incident.updated,incident.in_triage,incident.mitigated,incident.resolved,incident.cancelled,incident.deleted,incident.scheduled.created,incident.scheduled.updated,incident.scheduled.in_progress,incident.scheduled.completed,incident.scheduled.deleted,incident_post_mortem.created,incident_post_mortem.updated,incident_post_mortem.published,incident_post_mortem.deleted,alert.created,pulse.created,genius_workflow_run.queued,genius_workflow_run.started,genius_workflow_run.completed,genius_workflow_run.failed,genius_workflow_run.canceled. - name String
- The name of the endpoint
- secret String
- The webhook signing secret used to verify webhook requests.
- slug String
- The slug of the endpoint
- url String
- The URL of the endpoint.
Package Details
- Repository
- rootly rootlyhq/pulumi-rootly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rootlyTerraform Provider.