published on Thursday, Aug 20, 2026 by jschady
published on Thursday, Aug 20, 2026 by jschady
An EventSubscription selects EventRecords for an EventChannel and sends them to one or more EventTargets.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";
const exampleEventSubscription = new filescom.EventSubscription("example_event_subscription", {
eventChannelId: 1,
workspaceId: 1,
applyToAllWorkspaces: true,
name: "example",
subject: "example",
message: "example",
enabled: true,
eventTypes: ["example"],
deliveryPolicy: "example",
eventTargetIds: [1],
});
import pulumi
import pulumi_filescom as filescom
example_event_subscription = filescom.EventSubscription("example_event_subscription",
event_channel_id=1,
workspace_id=1,
apply_to_all_workspaces=True,
name="example",
subject="example",
message="example",
enabled=True,
event_types=["example"],
delivery_policy="example",
event_target_ids=[1])
package main
import (
"github.com/jschady/pulumi-filescom/sdk/go/filescom"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := filescom.NewEventSubscription(ctx, "example_event_subscription", &filescom.EventSubscriptionArgs{
EventChannelId: pulumi.Int(1),
WorkspaceId: pulumi.Int(1),
ApplyToAllWorkspaces: pulumi.Bool(true),
Name: pulumi.String("example"),
Subject: pulumi.String("example"),
Message: pulumi.String("example"),
Enabled: pulumi.Bool(true),
EventTypes: pulumi.StringArray{
pulumi.String("example"),
},
DeliveryPolicy: pulumi.Any("example"),
EventTargetIds: pulumi.IntArray{
pulumi.Int(1),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;
return await Deployment.RunAsync(() =>
{
var exampleEventSubscription = new Filescom.EventSubscription("example_event_subscription", new()
{
EventChannelId = 1,
WorkspaceId = 1,
ApplyToAllWorkspaces = true,
Name = "example",
Subject = "example",
Message = "example",
Enabled = true,
EventTypes = new[]
{
"example",
},
DeliveryPolicy = "example",
EventTargetIds = new[]
{
1,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.EventSubscription;
import com.pulumi.filescom.EventSubscriptionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
var exampleEventSubscription = new EventSubscription("exampleEventSubscription", EventSubscriptionArgs.builder()
.eventChannelId(1)
.workspaceId(1)
.applyToAllWorkspaces(true)
.name("example")
.subject("example")
.message("example")
.enabled(true)
.eventTypes("example")
.deliveryPolicy("example")
.eventTargetIds(1)
.build());
}
}
resources:
exampleEventSubscription:
type: filescom:EventSubscription
name: example_event_subscription
properties:
eventChannelId: 1
workspaceId: 1
applyToAllWorkspaces: true
name: example
subject: example
message: example
enabled: true
eventTypes:
- example
deliveryPolicy: example
eventTargetIds:
- 1
pulumi {
required_providers {
filescom = {
source = "pulumi/filescom"
}
}
}
resource "filescom_eventsubscription" "example_event_subscription" {
event_channel_id = 1
workspace_id = 1
apply_to_all_workspaces = true
name = "example"
subject = "example"
message = "example"
enabled = true
event_types = ["example"]
delivery_policy = "example"
event_target_ids = [1]
}
Create EventSubscription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EventSubscription(name: string, args?: EventSubscriptionArgs, opts?: CustomResourceOptions);@overload
def EventSubscription(resource_name: str,
args: Optional[EventSubscriptionArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def EventSubscription(resource_name: str,
opts: Optional[ResourceOptions] = None,
apply_to_all_workspaces: Optional[bool] = None,
delivery_policy: Optional[Any] = None,
enabled: Optional[bool] = None,
event_channel_id: Optional[int] = None,
event_target_ids: Optional[Sequence[int]] = None,
event_types: Optional[Sequence[str]] = None,
filter: Optional[Any] = None,
message: Optional[str] = None,
name: Optional[str] = None,
subject: Optional[str] = None,
workspace_id: Optional[int] = None)func NewEventSubscription(ctx *Context, name string, args *EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)public EventSubscription(string name, EventSubscriptionArgs? args = null, CustomResourceOptions? opts = null)
public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)
type: filescom:EventSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "filescom_event_subscription" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- 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 EventSubscriptionArgs
- 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 EventSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EventSubscriptionArgs
- 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 eventSubscriptionResource = new Filescom.EventSubscription("eventSubscriptionResource", new()
{
ApplyToAllWorkspaces = false,
DeliveryPolicy = "any",
Enabled = false,
EventChannelId = 0,
EventTargetIds = new[]
{
0,
},
EventTypes = new[]
{
"string",
},
Filter = "any",
Message = "string",
Name = "string",
Subject = "string",
WorkspaceId = 0,
});
example, err := filescom.NewEventSubscription(ctx, "eventSubscriptionResource", &filescom.EventSubscriptionArgs{
ApplyToAllWorkspaces: pulumi.Bool(false),
DeliveryPolicy: pulumi.Any("any"),
Enabled: pulumi.Bool(false),
EventChannelId: pulumi.Int(0),
EventTargetIds: pulumi.IntArray{
pulumi.Int(0),
},
EventTypes: pulumi.StringArray{
pulumi.String("string"),
},
Filter: pulumi.Any("any"),
Message: pulumi.String("string"),
Name: pulumi.String("string"),
Subject: pulumi.String("string"),
WorkspaceId: pulumi.Int(0),
})
resource "filescom_event_subscription" "eventSubscriptionResource" {
lifecycle {
create_before_destroy = true
}
apply_to_all_workspaces = false
delivery_policy = "any"
enabled = false
event_channel_id = 0
event_target_ids = [0]
event_types = ["string"]
filter = "any"
message = "string"
name = "string"
subject = "string"
workspace_id = 0
}
var eventSubscriptionResource = new EventSubscription("eventSubscriptionResource", EventSubscriptionArgs.builder()
.applyToAllWorkspaces(false)
.deliveryPolicy("any")
.enabled(false)
.eventChannelId(0)
.eventTargetIds(0)
.eventTypes("string")
.filter("any")
.message("string")
.name("string")
.subject("string")
.workspaceId(0)
.build());
event_subscription_resource = filescom.EventSubscription("eventSubscriptionResource",
apply_to_all_workspaces=False,
delivery_policy="any",
enabled=False,
event_channel_id=0,
event_target_ids=[0],
event_types=["string"],
filter="any",
message="string",
name="string",
subject="string",
workspace_id=0)
const eventSubscriptionResource = new filescom.EventSubscription("eventSubscriptionResource", {
applyToAllWorkspaces: false,
deliveryPolicy: "any",
enabled: false,
eventChannelId: 0,
eventTargetIds: [0],
eventTypes: ["string"],
filter: "any",
message: "string",
name: "string",
subject: "string",
workspaceId: 0,
});
type: filescom:EventSubscription
properties:
applyToAllWorkspaces: false
deliveryPolicy: any
enabled: false
eventChannelId: 0
eventTargetIds:
- 0
eventTypes:
- string
filter: any
message: string
name: string
subject: string
workspaceId: 0
EventSubscription 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 EventSubscription resource accepts the following input properties:
- Apply
To boolAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- Delivery
Policy object - Event Subscription delivery policy.
- Enabled bool
- Whether this Event Subscription can dispatch events.
- Event
Channel intId - Event Channel ID
- Event
Target List<int>Ids - Event Target IDs this subscription sends to.
- Event
Types List<string> - Event type strings matched by this subscription. Blank means all event types.
- Filter object
- Structured event payload filter.
- Message string
- Custom message to include in notification emails.
- Name string
- Event Subscription name.
- Subject string
- Custom subject line to use for notification emails.
- Workspace
Id int - Workspace ID. 0 means the default workspace or site-wide.
- Apply
To boolAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- Delivery
Policy interface{} - Event Subscription delivery policy.
- Enabled bool
- Whether this Event Subscription can dispatch events.
- Event
Channel intId - Event Channel ID
- Event
Target []intIds - Event Target IDs this subscription sends to.
- Event
Types []string - Event type strings matched by this subscription. Blank means all event types.
- Filter interface{}
- Structured event payload filter.
- Message string
- Custom message to include in notification emails.
- Name string
- Event Subscription name.
- Subject string
- Custom subject line to use for notification emails.
- Workspace
Id int - Workspace ID. 0 means the default workspace or site-wide.
- apply_
to_ boolall_ workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- delivery_
policy any - Event Subscription delivery policy.
- enabled bool
- Whether this Event Subscription can dispatch events.
- event_
channel_ numberid - Event Channel ID
- event_
target_ list(number)ids - Event Target IDs this subscription sends to.
- event_
types list(string) - Event type strings matched by this subscription. Blank means all event types.
- filter any
- Structured event payload filter.
- message string
- Custom message to include in notification emails.
- name string
- Event Subscription name.
- subject string
- Custom subject line to use for notification emails.
- workspace_
id number - Workspace ID. 0 means the default workspace or site-wide.
- apply
To BooleanAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- delivery
Policy Object - Event Subscription delivery policy.
- enabled Boolean
- Whether this Event Subscription can dispatch events.
- event
Channel IntegerId - Event Channel ID
- event
Target List<Integer>Ids - Event Target IDs this subscription sends to.
- event
Types List<String> - Event type strings matched by this subscription. Blank means all event types.
- filter Object
- Structured event payload filter.
- message String
- Custom message to include in notification emails.
- name String
- Event Subscription name.
- subject String
- Custom subject line to use for notification emails.
- workspace
Id Integer - Workspace ID. 0 means the default workspace or site-wide.
- apply
To booleanAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- delivery
Policy any - Event Subscription delivery policy.
- enabled boolean
- Whether this Event Subscription can dispatch events.
- event
Channel numberId - Event Channel ID
- event
Target number[]Ids - Event Target IDs this subscription sends to.
- event
Types string[] - Event type strings matched by this subscription. Blank means all event types.
- filter any
- Structured event payload filter.
- message string
- Custom message to include in notification emails.
- name string
- Event Subscription name.
- subject string
- Custom subject line to use for notification emails.
- workspace
Id number - Workspace ID. 0 means the default workspace or site-wide.
- apply_
to_ boolall_ workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- delivery_
policy Any - Event Subscription delivery policy.
- enabled bool
- Whether this Event Subscription can dispatch events.
- event_
channel_ intid - Event Channel ID
- event_
target_ Sequence[int]ids - Event Target IDs this subscription sends to.
- event_
types Sequence[str] - Event type strings matched by this subscription. Blank means all event types.
- filter Any
- Structured event payload filter.
- message str
- Custom message to include in notification emails.
- name str
- Event Subscription name.
- subject str
- Custom subject line to use for notification emails.
- workspace_
id int - Workspace ID. 0 means the default workspace or site-wide.
- apply
To BooleanAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- delivery
Policy Any - Event Subscription delivery policy.
- enabled Boolean
- Whether this Event Subscription can dispatch events.
- event
Channel NumberId - Event Channel ID
- event
Target List<Number>Ids - Event Target IDs this subscription sends to.
- event
Types List<String> - Event type strings matched by this subscription. Blank means all event types.
- filter Any
- Structured event payload filter.
- message String
- Custom message to include in notification emails.
- name String
- Event Subscription name.
- subject String
- Custom subject line to use for notification emails.
- workspace
Id Number - Workspace ID. 0 means the default workspace or site-wide.
Outputs
All input properties are implicitly available as output properties. Additionally, the EventSubscription resource produces the following output properties:
- created_
at string - Event Subscription create date/time.
- id string
- The provider-assigned unique ID for this managed resource.
- updated_
at string - Event Subscription update date/time.
- created_
at str - Event Subscription create date/time.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - Event Subscription update date/time.
Look up Existing EventSubscription Resource
Get an existing EventSubscription 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?: EventSubscriptionState, opts?: CustomResourceOptions): EventSubscription@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
apply_to_all_workspaces: Optional[bool] = None,
created_at: Optional[str] = None,
delivery_policy: Optional[Any] = None,
enabled: Optional[bool] = None,
event_channel_id: Optional[int] = None,
event_target_ids: Optional[Sequence[int]] = None,
event_types: Optional[Sequence[str]] = None,
filter: Optional[Any] = None,
message: Optional[str] = None,
name: Optional[str] = None,
subject: Optional[str] = None,
updated_at: Optional[str] = None,
workspace_id: Optional[int] = None) -> EventSubscriptionfunc GetEventSubscription(ctx *Context, name string, id IDInput, state *EventSubscriptionState, opts ...ResourceOption) (*EventSubscription, error)public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState? state, CustomResourceOptions? opts = null)public static EventSubscription get(String name, Output<String> id, EventSubscriptionState state, CustomResourceOptions options)resources: _: type: filescom:EventSubscription get: id: ${id}import {
to = filescom_event_subscription.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.
- Apply
To boolAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- Created
At string - Event Subscription create date/time.
- Delivery
Policy object - Event Subscription delivery policy.
- Enabled bool
- Whether this Event Subscription can dispatch events.
- Event
Channel intId - Event Channel ID
- Event
Target List<int>Ids - Event Target IDs this subscription sends to.
- Event
Types List<string> - Event type strings matched by this subscription. Blank means all event types.
- Filter object
- Structured event payload filter.
- Message string
- Custom message to include in notification emails.
- Name string
- Event Subscription name.
- Subject string
- Custom subject line to use for notification emails.
- Updated
At string - Event Subscription update date/time.
- Workspace
Id int - Workspace ID. 0 means the default workspace or site-wide.
- Apply
To boolAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- Created
At string - Event Subscription create date/time.
- Delivery
Policy interface{} - Event Subscription delivery policy.
- Enabled bool
- Whether this Event Subscription can dispatch events.
- Event
Channel intId - Event Channel ID
- Event
Target []intIds - Event Target IDs this subscription sends to.
- Event
Types []string - Event type strings matched by this subscription. Blank means all event types.
- Filter interface{}
- Structured event payload filter.
- Message string
- Custom message to include in notification emails.
- Name string
- Event Subscription name.
- Subject string
- Custom subject line to use for notification emails.
- Updated
At string - Event Subscription update date/time.
- Workspace
Id int - Workspace ID. 0 means the default workspace or site-wide.
- apply_
to_ boolall_ workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- created_
at string - Event Subscription create date/time.
- delivery_
policy any - Event Subscription delivery policy.
- enabled bool
- Whether this Event Subscription can dispatch events.
- event_
channel_ numberid - Event Channel ID
- event_
target_ list(number)ids - Event Target IDs this subscription sends to.
- event_
types list(string) - Event type strings matched by this subscription. Blank means all event types.
- filter any
- Structured event payload filter.
- message string
- Custom message to include in notification emails.
- name string
- Event Subscription name.
- subject string
- Custom subject line to use for notification emails.
- updated_
at string - Event Subscription update date/time.
- workspace_
id number - Workspace ID. 0 means the default workspace or site-wide.
- apply
To BooleanAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- created
At String - Event Subscription create date/time.
- delivery
Policy Object - Event Subscription delivery policy.
- enabled Boolean
- Whether this Event Subscription can dispatch events.
- event
Channel IntegerId - Event Channel ID
- event
Target List<Integer>Ids - Event Target IDs this subscription sends to.
- event
Types List<String> - Event type strings matched by this subscription. Blank means all event types.
- filter Object
- Structured event payload filter.
- message String
- Custom message to include in notification emails.
- name String
- Event Subscription name.
- subject String
- Custom subject line to use for notification emails.
- updated
At String - Event Subscription update date/time.
- workspace
Id Integer - Workspace ID. 0 means the default workspace or site-wide.
- apply
To booleanAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- created
At string - Event Subscription create date/time.
- delivery
Policy any - Event Subscription delivery policy.
- enabled boolean
- Whether this Event Subscription can dispatch events.
- event
Channel numberId - Event Channel ID
- event
Target number[]Ids - Event Target IDs this subscription sends to.
- event
Types string[] - Event type strings matched by this subscription. Blank means all event types.
- filter any
- Structured event payload filter.
- message string
- Custom message to include in notification emails.
- name string
- Event Subscription name.
- subject string
- Custom subject line to use for notification emails.
- updated
At string - Event Subscription update date/time.
- workspace
Id number - Workspace ID. 0 means the default workspace or site-wide.
- apply_
to_ boolall_ workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- created_
at str - Event Subscription create date/time.
- delivery_
policy Any - Event Subscription delivery policy.
- enabled bool
- Whether this Event Subscription can dispatch events.
- event_
channel_ intid - Event Channel ID
- event_
target_ Sequence[int]ids - Event Target IDs this subscription sends to.
- event_
types Sequence[str] - Event type strings matched by this subscription. Blank means all event types.
- filter Any
- Structured event payload filter.
- message str
- Custom message to include in notification emails.
- name str
- Event Subscription name.
- subject str
- Custom subject line to use for notification emails.
- updated_
at str - Event Subscription update date/time.
- workspace_
id int - Workspace ID. 0 means the default workspace or site-wide.
- apply
To BooleanAll Workspaces - If true, this default-workspace subscription applies to events from all workspaces.
- created
At String - Event Subscription create date/time.
- delivery
Policy Any - Event Subscription delivery policy.
- enabled Boolean
- Whether this Event Subscription can dispatch events.
- event
Channel NumberId - Event Channel ID
- event
Target List<Number>Ids - Event Target IDs this subscription sends to.
- event
Types List<String> - Event type strings matched by this subscription. Blank means all event types.
- filter Any
- Structured event payload filter.
- message String
- Custom message to include in notification emails.
- name String
- Event Subscription name.
- subject String
- Custom subject line to use for notification emails.
- updated
At String - Event Subscription update date/time.
- workspace
Id Number - Workspace ID. 0 means the default workspace or site-wide.
Import
The pulumi import command can be used, for example:
Event Subscriptions can be imported by specifying the id.
$ pulumi import filescom:index/eventSubscription:EventSubscription example_event_subscription 1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- filescom jschady/pulumi-filescom
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
filescomTerraform Provider.
published on Thursday, Aug 20, 2026 by jschady