1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. Notification
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A Notification is our feature that sends E-Mails when specific actions occur in the folder.

    Emails are sent in batches, with email frequency options of every 5 minutes, every 15 minutes, hourly, or daily. They will include a list of the matching actions within the configured notification period, limited to the first 100.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleNotification = new filescom.Notification("example_notification", {
        userId: 1,
        notifyOnCopy: false,
        notifyOnDelete: true,
        notifyOnDownload: true,
        notifyOnMove: true,
        notifyOnUpload: true,
        notifyUserActions: false,
        recursive: false,
        sendInterval: "daily",
        subject: "Vendor A CSV Activity",
        message: "custom notification email message",
        triggeringFilenames: [
            "*.jpg",
            "notify_file.txt",
        ],
        triggeringGroupIds: [1],
        triggeringUserIds: [1],
        triggerByShareRecipients: true,
        workspaceId: 1,
        groupId: 1,
        groupIds: [1],
        username: "User",
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_notification = filescom.Notification("example_notification",
        user_id=1,
        notify_on_copy=False,
        notify_on_delete=True,
        notify_on_download=True,
        notify_on_move=True,
        notify_on_upload=True,
        notify_user_actions=False,
        recursive=False,
        send_interval="daily",
        subject="Vendor A CSV Activity",
        message="custom notification email message",
        triggering_filenames=[
            "*.jpg",
            "notify_file.txt",
        ],
        triggering_group_ids=[1],
        triggering_user_ids=[1],
        trigger_by_share_recipients=True,
        workspace_id=1,
        group_id=1,
        group_ids=[1],
        username="User")
    
    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.NewNotification(ctx, "example_notification", &filescom.NotificationArgs{
    			UserId:            pulumi.Int(1),
    			NotifyOnCopy:      pulumi.Bool(false),
    			NotifyOnDelete:    pulumi.Bool(true),
    			NotifyOnDownload:  pulumi.Bool(true),
    			NotifyOnMove:      pulumi.Bool(true),
    			NotifyOnUpload:    pulumi.Bool(true),
    			NotifyUserActions: pulumi.Bool(false),
    			Recursive:         pulumi.Bool(false),
    			SendInterval:      pulumi.String("daily"),
    			Subject:           pulumi.String("Vendor A CSV Activity"),
    			Message:           pulumi.String("custom notification email message"),
    			TriggeringFilenames: pulumi.StringArray{
    				pulumi.String("*.jpg"),
    				pulumi.String("notify_file.txt"),
    			},
    			TriggeringGroupIds: pulumi.IntArray{
    				pulumi.Int(1),
    			},
    			TriggeringUserIds: pulumi.IntArray{
    				pulumi.Int(1),
    			},
    			TriggerByShareRecipients: pulumi.Bool(true),
    			WorkspaceId:              pulumi.Int(1),
    			GroupId:                  pulumi.Int(1),
    			GroupIds: pulumi.IntArray{
    				pulumi.Int(1),
    			},
    			Username: pulumi.String("User"),
    		})
    		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 exampleNotification = new Filescom.Notification("example_notification", new()
        {
            UserId = 1,
            NotifyOnCopy = false,
            NotifyOnDelete = true,
            NotifyOnDownload = true,
            NotifyOnMove = true,
            NotifyOnUpload = true,
            NotifyUserActions = false,
            Recursive = false,
            SendInterval = "daily",
            Subject = "Vendor A CSV Activity",
            Message = "custom notification email message",
            TriggeringFilenames = new[]
            {
                "*.jpg",
                "notify_file.txt",
            },
            TriggeringGroupIds = new[]
            {
                1,
            },
            TriggeringUserIds = new[]
            {
                1,
            },
            TriggerByShareRecipients = true,
            WorkspaceId = 1,
            GroupId = 1,
            GroupIds = new[]
            {
                1,
            },
            Username = "User",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.Notification;
    import com.pulumi.filescom.NotificationArgs;
    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 exampleNotification = new Notification("exampleNotification", NotificationArgs.builder()
                .userId(1)
                .notifyOnCopy(false)
                .notifyOnDelete(true)
                .notifyOnDownload(true)
                .notifyOnMove(true)
                .notifyOnUpload(true)
                .notifyUserActions(false)
                .recursive(false)
                .sendInterval("daily")
                .subject("Vendor A CSV Activity")
                .message("custom notification email message")
                .triggeringFilenames(            
                    "*.jpg",
                    "notify_file.txt")
                .triggeringGroupIds(1)
                .triggeringUserIds(1)
                .triggerByShareRecipients(true)
                .workspaceId(1)
                .groupId(1)
                .groupIds(1)
                .username("User")
                .build());
    
        }
    }
    
    resources:
      exampleNotification:
        type: filescom:Notification
        name: example_notification
        properties:
          userId: 1
          notifyOnCopy: false
          notifyOnDelete: true
          notifyOnDownload: true
          notifyOnMove: true
          notifyOnUpload: true
          notifyUserActions: false
          recursive: false
          sendInterval: daily
          subject: Vendor A CSV Activity
          message: custom notification email message
          triggeringFilenames:
            - '*.jpg'
            - notify_file.txt
          triggeringGroupIds:
            - 1
          triggeringUserIds:
            - 1
          triggerByShareRecipients: true
          workspaceId: 1
          groupId: 1
          groupIds:
            - 1
          username: User
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_notification" "example_notification" {
      user_id                     = 1
      notify_on_copy              = false
      notify_on_delete            = true
      notify_on_download          = true
      notify_on_move              = true
      notify_on_upload            = true
      notify_user_actions         = false
      recursive                   = false
      send_interval               = "daily"
      subject                     = "Vendor A CSV Activity"
      message                     = "custom notification email message"
      triggering_filenames        = ["*.jpg", "notify_file.txt"]
      triggering_group_ids        = [1]
      triggering_user_ids         = [1]
      trigger_by_share_recipients = true
      workspace_id                = 1
      group_id                    = 1
      group_ids                   = [1]
      username                    = "User"
    }
    

    Create Notification Resource

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

    Constructor syntax

    new Notification(name: string, args?: NotificationArgs, opts?: CustomResourceOptions);
    @overload
    def Notification(resource_name: str,
                     args: Optional[NotificationArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def Notification(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     group_id: Optional[int] = None,
                     group_ids: Optional[Sequence[int]] = None,
                     message: Optional[str] = None,
                     notify_on_copy: Optional[bool] = None,
                     notify_on_delete: Optional[bool] = None,
                     notify_on_download: Optional[bool] = None,
                     notify_on_move: Optional[bool] = None,
                     notify_on_upload: Optional[bool] = None,
                     notify_user_actions: Optional[bool] = None,
                     path: Optional[str] = None,
                     recursive: Optional[bool] = None,
                     send_interval: Optional[str] = None,
                     subject: Optional[str] = None,
                     trigger_by_share_recipients: Optional[bool] = None,
                     triggering_filenames: Optional[Sequence[str]] = None,
                     triggering_group_ids: Optional[Sequence[int]] = None,
                     triggering_user_ids: Optional[Sequence[int]] = None,
                     user_id: Optional[int] = None,
                     username: Optional[str] = None,
                     workspace_id: Optional[int] = None)
    func NewNotification(ctx *Context, name string, args *NotificationArgs, opts ...ResourceOption) (*Notification, error)
    public Notification(string name, NotificationArgs? args = null, CustomResourceOptions? opts = null)
    public Notification(String name, NotificationArgs args)
    public Notification(String name, NotificationArgs args, CustomResourceOptions options)
    
    type: filescom:Notification
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_notification" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args NotificationArgs
    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 NotificationArgs
    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 NotificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationArgs
    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 notificationResource = new Filescom.Notification("notificationResource", new()
    {
        GroupId = 0,
        GroupIds = new[]
        {
            0,
        },
        Message = "string",
        NotifyOnCopy = false,
        NotifyOnDelete = false,
        NotifyOnDownload = false,
        NotifyOnMove = false,
        NotifyOnUpload = false,
        NotifyUserActions = false,
        Path = "string",
        Recursive = false,
        SendInterval = "string",
        Subject = "string",
        TriggerByShareRecipients = false,
        TriggeringFilenames = new[]
        {
            "string",
        },
        TriggeringGroupIds = new[]
        {
            0,
        },
        TriggeringUserIds = new[]
        {
            0,
        },
        UserId = 0,
        Username = "string",
        WorkspaceId = 0,
    });
    
    example, err := filescom.NewNotification(ctx, "notificationResource", &filescom.NotificationArgs{
    	GroupId: pulumi.Int(0),
    	GroupIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	Message:                  pulumi.String("string"),
    	NotifyOnCopy:             pulumi.Bool(false),
    	NotifyOnDelete:           pulumi.Bool(false),
    	NotifyOnDownload:         pulumi.Bool(false),
    	NotifyOnMove:             pulumi.Bool(false),
    	NotifyOnUpload:           pulumi.Bool(false),
    	NotifyUserActions:        pulumi.Bool(false),
    	Path:                     pulumi.String("string"),
    	Recursive:                pulumi.Bool(false),
    	SendInterval:             pulumi.String("string"),
    	Subject:                  pulumi.String("string"),
    	TriggerByShareRecipients: pulumi.Bool(false),
    	TriggeringFilenames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TriggeringGroupIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	TriggeringUserIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	UserId:      pulumi.Int(0),
    	Username:    pulumi.String("string"),
    	WorkspaceId: pulumi.Int(0),
    })
    
    resource "filescom_notification" "notificationResource" {
      lifecycle {
        create_before_destroy = true
      }
      group_id                    = 0
      group_ids                   = [0]
      message                     = "string"
      notify_on_copy              = false
      notify_on_delete            = false
      notify_on_download          = false
      notify_on_move              = false
      notify_on_upload            = false
      notify_user_actions         = false
      path                        = "string"
      recursive                   = false
      send_interval               = "string"
      subject                     = "string"
      trigger_by_share_recipients = false
      triggering_filenames        = ["string"]
      triggering_group_ids        = [0]
      triggering_user_ids         = [0]
      user_id                     = 0
      username                    = "string"
      workspace_id                = 0
    }
    
    var notificationResource = new Notification("notificationResource", NotificationArgs.builder()
        .groupId(0)
        .groupIds(0)
        .message("string")
        .notifyOnCopy(false)
        .notifyOnDelete(false)
        .notifyOnDownload(false)
        .notifyOnMove(false)
        .notifyOnUpload(false)
        .notifyUserActions(false)
        .path("string")
        .recursive(false)
        .sendInterval("string")
        .subject("string")
        .triggerByShareRecipients(false)
        .triggeringFilenames("string")
        .triggeringGroupIds(0)
        .triggeringUserIds(0)
        .userId(0)
        .username("string")
        .workspaceId(0)
        .build());
    
    notification_resource = filescom.Notification("notificationResource",
        group_id=0,
        group_ids=[0],
        message="string",
        notify_on_copy=False,
        notify_on_delete=False,
        notify_on_download=False,
        notify_on_move=False,
        notify_on_upload=False,
        notify_user_actions=False,
        path="string",
        recursive=False,
        send_interval="string",
        subject="string",
        trigger_by_share_recipients=False,
        triggering_filenames=["string"],
        triggering_group_ids=[0],
        triggering_user_ids=[0],
        user_id=0,
        username="string",
        workspace_id=0)
    
    const notificationResource = new filescom.Notification("notificationResource", {
        groupId: 0,
        groupIds: [0],
        message: "string",
        notifyOnCopy: false,
        notifyOnDelete: false,
        notifyOnDownload: false,
        notifyOnMove: false,
        notifyOnUpload: false,
        notifyUserActions: false,
        path: "string",
        recursive: false,
        sendInterval: "string",
        subject: "string",
        triggerByShareRecipients: false,
        triggeringFilenames: ["string"],
        triggeringGroupIds: [0],
        triggeringUserIds: [0],
        userId: 0,
        username: "string",
        workspaceId: 0,
    });
    
    type: filescom:Notification
    properties:
        groupId: 0
        groupIds:
            - 0
        message: string
        notifyOnCopy: false
        notifyOnDelete: false
        notifyOnDownload: false
        notifyOnMove: false
        notifyOnUpload: false
        notifyUserActions: false
        path: string
        recursive: false
        sendInterval: string
        subject: string
        triggerByShareRecipients: false
        triggeringFilenames:
            - string
        triggeringGroupIds:
            - 0
        triggeringUserIds:
            - 0
        userId: 0
        username: string
        workspaceId: 0
    

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

    GroupId int
    ID of Group to receive notifications
    GroupIds List<int>
    Group IDs when the notification requires multiple groups
    Message string
    Custom message to include in notification emails
    NotifyOnCopy bool
    Trigger on files copied to this path?
    NotifyOnDelete bool
    Trigger on files deleted in this path?
    NotifyOnDownload bool
    Trigger on files downloaded in this path?
    NotifyOnMove bool
    Trigger on files moved to this path?
    NotifyOnUpload bool
    Trigger on files created/uploaded/updated/changed in this path?
    NotifyUserActions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    Path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    SendInterval string
    The time interval that notifications are aggregated to
    Subject string
    Custom subject line to use for notification emails
    TriggerByShareRecipients bool
    Notify when actions are performed by a share recipient?
    TriggeringFilenames List<string>
    Array of filenames (possibly with wildcards) to scope trigger
    TriggeringGroupIds List<int>
    If set, will only notify on actions made by a member of one of the specified groups
    TriggeringUserIds List<int>
    If set, will only notify on actions made one of the specified users
    UserId int
    Notification user ID
    Username string
    Notification username
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    GroupId int
    ID of Group to receive notifications
    GroupIds []int
    Group IDs when the notification requires multiple groups
    Message string
    Custom message to include in notification emails
    NotifyOnCopy bool
    Trigger on files copied to this path?
    NotifyOnDelete bool
    Trigger on files deleted in this path?
    NotifyOnDownload bool
    Trigger on files downloaded in this path?
    NotifyOnMove bool
    Trigger on files moved to this path?
    NotifyOnUpload bool
    Trigger on files created/uploaded/updated/changed in this path?
    NotifyUserActions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    Path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    SendInterval string
    The time interval that notifications are aggregated to
    Subject string
    Custom subject line to use for notification emails
    TriggerByShareRecipients bool
    Notify when actions are performed by a share recipient?
    TriggeringFilenames []string
    Array of filenames (possibly with wildcards) to scope trigger
    TriggeringGroupIds []int
    If set, will only notify on actions made by a member of one of the specified groups
    TriggeringUserIds []int
    If set, will only notify on actions made one of the specified users
    UserId int
    Notification user ID
    Username string
    Notification username
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    group_id number
    ID of Group to receive notifications
    group_ids list(number)
    Group IDs when the notification requires multiple groups
    message string
    Custom message to include in notification emails
    notify_on_copy bool
    Trigger on files copied to this path?
    notify_on_delete bool
    Trigger on files deleted in this path?
    notify_on_download bool
    Trigger on files downloaded in this path?
    notify_on_move bool
    Trigger on files moved to this path?
    notify_on_upload bool
    Trigger on files created/uploaded/updated/changed in this path?
    notify_user_actions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    send_interval string
    The time interval that notifications are aggregated to
    subject string
    Custom subject line to use for notification emails
    trigger_by_share_recipients bool
    Notify when actions are performed by a share recipient?
    triggering_filenames list(string)
    Array of filenames (possibly with wildcards) to scope trigger
    triggering_group_ids list(number)
    If set, will only notify on actions made by a member of one of the specified groups
    triggering_user_ids list(number)
    If set, will only notify on actions made one of the specified users
    user_id number
    Notification user ID
    username string
    Notification username
    workspace_id number
    Workspace ID. 0 means the default workspace.
    groupId Integer
    ID of Group to receive notifications
    groupIds List<Integer>
    Group IDs when the notification requires multiple groups
    message String
    Custom message to include in notification emails
    notifyOnCopy Boolean
    Trigger on files copied to this path?
    notifyOnDelete Boolean
    Trigger on files deleted in this path?
    notifyOnDownload Boolean
    Trigger on files downloaded in this path?
    notifyOnMove Boolean
    Trigger on files moved to this path?
    notifyOnUpload Boolean
    Trigger on files created/uploaded/updated/changed in this path?
    notifyUserActions Boolean
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path String
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive Boolean
    Apply notification recursively? This will enable notifications for each subfolder.
    sendInterval String
    The time interval that notifications are aggregated to
    subject String
    Custom subject line to use for notification emails
    triggerByShareRecipients Boolean
    Notify when actions are performed by a share recipient?
    triggeringFilenames List<String>
    Array of filenames (possibly with wildcards) to scope trigger
    triggeringGroupIds List<Integer>
    If set, will only notify on actions made by a member of one of the specified groups
    triggeringUserIds List<Integer>
    If set, will only notify on actions made one of the specified users
    userId Integer
    Notification user ID
    username String
    Notification username
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    groupId number
    ID of Group to receive notifications
    groupIds number[]
    Group IDs when the notification requires multiple groups
    message string
    Custom message to include in notification emails
    notifyOnCopy boolean
    Trigger on files copied to this path?
    notifyOnDelete boolean
    Trigger on files deleted in this path?
    notifyOnDownload boolean
    Trigger on files downloaded in this path?
    notifyOnMove boolean
    Trigger on files moved to this path?
    notifyOnUpload boolean
    Trigger on files created/uploaded/updated/changed in this path?
    notifyUserActions boolean
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive boolean
    Apply notification recursively? This will enable notifications for each subfolder.
    sendInterval string
    The time interval that notifications are aggregated to
    subject string
    Custom subject line to use for notification emails
    triggerByShareRecipients boolean
    Notify when actions are performed by a share recipient?
    triggeringFilenames string[]
    Array of filenames (possibly with wildcards) to scope trigger
    triggeringGroupIds number[]
    If set, will only notify on actions made by a member of one of the specified groups
    triggeringUserIds number[]
    If set, will only notify on actions made one of the specified users
    userId number
    Notification user ID
    username string
    Notification username
    workspaceId number
    Workspace ID. 0 means the default workspace.
    group_id int
    ID of Group to receive notifications
    group_ids Sequence[int]
    Group IDs when the notification requires multiple groups
    message str
    Custom message to include in notification emails
    notify_on_copy bool
    Trigger on files copied to this path?
    notify_on_delete bool
    Trigger on files deleted in this path?
    notify_on_download bool
    Trigger on files downloaded in this path?
    notify_on_move bool
    Trigger on files moved to this path?
    notify_on_upload bool
    Trigger on files created/uploaded/updated/changed in this path?
    notify_user_actions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path str
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    send_interval str
    The time interval that notifications are aggregated to
    subject str
    Custom subject line to use for notification emails
    trigger_by_share_recipients bool
    Notify when actions are performed by a share recipient?
    triggering_filenames Sequence[str]
    Array of filenames (possibly with wildcards) to scope trigger
    triggering_group_ids Sequence[int]
    If set, will only notify on actions made by a member of one of the specified groups
    triggering_user_ids Sequence[int]
    If set, will only notify on actions made one of the specified users
    user_id int
    Notification user ID
    username str
    Notification username
    workspace_id int
    Workspace ID. 0 means the default workspace.
    groupId Number
    ID of Group to receive notifications
    groupIds List<Number>
    Group IDs when the notification requires multiple groups
    message String
    Custom message to include in notification emails
    notifyOnCopy Boolean
    Trigger on files copied to this path?
    notifyOnDelete Boolean
    Trigger on files deleted in this path?
    notifyOnDownload Boolean
    Trigger on files downloaded in this path?
    notifyOnMove Boolean
    Trigger on files moved to this path?
    notifyOnUpload Boolean
    Trigger on files created/uploaded/updated/changed in this path?
    notifyUserActions Boolean
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path String
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive Boolean
    Apply notification recursively? This will enable notifications for each subfolder.
    sendInterval String
    The time interval that notifications are aggregated to
    subject String
    Custom subject line to use for notification emails
    triggerByShareRecipients Boolean
    Notify when actions are performed by a share recipient?
    triggeringFilenames List<String>
    Array of filenames (possibly with wildcards) to scope trigger
    triggeringGroupIds List<Number>
    If set, will only notify on actions made by a member of one of the specified groups
    triggeringUserIds List<Number>
    If set, will only notify on actions made one of the specified users
    userId Number
    Notification user ID
    username String
    Notification username
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Outputs

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

    GroupName string
    Group name, if a Group ID is set
    GroupNames List<string>
    Group names when the notification requires multiple groups
    Id string
    The provider-assigned unique ID for this managed resource.
    SuppressedEmail bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    Unsubscribed bool
    Is the user unsubscribed from this notification?
    UnsubscribedReason string
    The reason that the user unsubscribed
    GroupName string
    Group name, if a Group ID is set
    GroupNames []string
    Group names when the notification requires multiple groups
    Id string
    The provider-assigned unique ID for this managed resource.
    SuppressedEmail bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    Unsubscribed bool
    Is the user unsubscribed from this notification?
    UnsubscribedReason string
    The reason that the user unsubscribed
    group_name string
    Group name, if a Group ID is set
    group_names list(string)
    Group names when the notification requires multiple groups
    id string
    The provider-assigned unique ID for this managed resource.
    suppressed_email bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    unsubscribed bool
    Is the user unsubscribed from this notification?
    unsubscribed_reason string
    The reason that the user unsubscribed
    groupName String
    Group name, if a Group ID is set
    groupNames List<String>
    Group names when the notification requires multiple groups
    id String
    The provider-assigned unique ID for this managed resource.
    suppressedEmail Boolean
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    unsubscribed Boolean
    Is the user unsubscribed from this notification?
    unsubscribedReason String
    The reason that the user unsubscribed
    groupName string
    Group name, if a Group ID is set
    groupNames string[]
    Group names when the notification requires multiple groups
    id string
    The provider-assigned unique ID for this managed resource.
    suppressedEmail boolean
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    unsubscribed boolean
    Is the user unsubscribed from this notification?
    unsubscribedReason string
    The reason that the user unsubscribed
    group_name str
    Group name, if a Group ID is set
    group_names Sequence[str]
    Group names when the notification requires multiple groups
    id str
    The provider-assigned unique ID for this managed resource.
    suppressed_email bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    unsubscribed bool
    Is the user unsubscribed from this notification?
    unsubscribed_reason str
    The reason that the user unsubscribed
    groupName String
    Group name, if a Group ID is set
    groupNames List<String>
    Group names when the notification requires multiple groups
    id String
    The provider-assigned unique ID for this managed resource.
    suppressedEmail Boolean
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    unsubscribed Boolean
    Is the user unsubscribed from this notification?
    unsubscribedReason String
    The reason that the user unsubscribed

    Look up Existing Notification Resource

    Get an existing Notification 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?: NotificationState, opts?: CustomResourceOptions): Notification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            group_id: Optional[int] = None,
            group_ids: Optional[Sequence[int]] = None,
            group_name: Optional[str] = None,
            group_names: Optional[Sequence[str]] = None,
            message: Optional[str] = None,
            notify_on_copy: Optional[bool] = None,
            notify_on_delete: Optional[bool] = None,
            notify_on_download: Optional[bool] = None,
            notify_on_move: Optional[bool] = None,
            notify_on_upload: Optional[bool] = None,
            notify_user_actions: Optional[bool] = None,
            path: Optional[str] = None,
            recursive: Optional[bool] = None,
            send_interval: Optional[str] = None,
            subject: Optional[str] = None,
            suppressed_email: Optional[bool] = None,
            trigger_by_share_recipients: Optional[bool] = None,
            triggering_filenames: Optional[Sequence[str]] = None,
            triggering_group_ids: Optional[Sequence[int]] = None,
            triggering_user_ids: Optional[Sequence[int]] = None,
            unsubscribed: Optional[bool] = None,
            unsubscribed_reason: Optional[str] = None,
            user_id: Optional[int] = None,
            username: Optional[str] = None,
            workspace_id: Optional[int] = None) -> Notification
    func GetNotification(ctx *Context, name string, id IDInput, state *NotificationState, opts ...ResourceOption) (*Notification, error)
    public static Notification Get(string name, Input<string> id, NotificationState? state, CustomResourceOptions? opts = null)
    public static Notification get(String name, Output<String> id, NotificationState state, CustomResourceOptions options)
    resources:  _:    type: filescom:Notification    get:      id: ${id}
    import {
      to = filescom_notification.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:
    GroupId int
    ID of Group to receive notifications
    GroupIds List<int>
    Group IDs when the notification requires multiple groups
    GroupName string
    Group name, if a Group ID is set
    GroupNames List<string>
    Group names when the notification requires multiple groups
    Message string
    Custom message to include in notification emails
    NotifyOnCopy bool
    Trigger on files copied to this path?
    NotifyOnDelete bool
    Trigger on files deleted in this path?
    NotifyOnDownload bool
    Trigger on files downloaded in this path?
    NotifyOnMove bool
    Trigger on files moved to this path?
    NotifyOnUpload bool
    Trigger on files created/uploaded/updated/changed in this path?
    NotifyUserActions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    Path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    SendInterval string
    The time interval that notifications are aggregated to
    Subject string
    Custom subject line to use for notification emails
    SuppressedEmail bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    TriggerByShareRecipients bool
    Notify when actions are performed by a share recipient?
    TriggeringFilenames List<string>
    Array of filenames (possibly with wildcards) to scope trigger
    TriggeringGroupIds List<int>
    If set, will only notify on actions made by a member of one of the specified groups
    TriggeringUserIds List<int>
    If set, will only notify on actions made one of the specified users
    Unsubscribed bool
    Is the user unsubscribed from this notification?
    UnsubscribedReason string
    The reason that the user unsubscribed
    UserId int
    Notification user ID
    Username string
    Notification username
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    GroupId int
    ID of Group to receive notifications
    GroupIds []int
    Group IDs when the notification requires multiple groups
    GroupName string
    Group name, if a Group ID is set
    GroupNames []string
    Group names when the notification requires multiple groups
    Message string
    Custom message to include in notification emails
    NotifyOnCopy bool
    Trigger on files copied to this path?
    NotifyOnDelete bool
    Trigger on files deleted in this path?
    NotifyOnDownload bool
    Trigger on files downloaded in this path?
    NotifyOnMove bool
    Trigger on files moved to this path?
    NotifyOnUpload bool
    Trigger on files created/uploaded/updated/changed in this path?
    NotifyUserActions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    Path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    SendInterval string
    The time interval that notifications are aggregated to
    Subject string
    Custom subject line to use for notification emails
    SuppressedEmail bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    TriggerByShareRecipients bool
    Notify when actions are performed by a share recipient?
    TriggeringFilenames []string
    Array of filenames (possibly with wildcards) to scope trigger
    TriggeringGroupIds []int
    If set, will only notify on actions made by a member of one of the specified groups
    TriggeringUserIds []int
    If set, will only notify on actions made one of the specified users
    Unsubscribed bool
    Is the user unsubscribed from this notification?
    UnsubscribedReason string
    The reason that the user unsubscribed
    UserId int
    Notification user ID
    Username string
    Notification username
    WorkspaceId int
    Workspace ID. 0 means the default workspace.
    group_id number
    ID of Group to receive notifications
    group_ids list(number)
    Group IDs when the notification requires multiple groups
    group_name string
    Group name, if a Group ID is set
    group_names list(string)
    Group names when the notification requires multiple groups
    message string
    Custom message to include in notification emails
    notify_on_copy bool
    Trigger on files copied to this path?
    notify_on_delete bool
    Trigger on files deleted in this path?
    notify_on_download bool
    Trigger on files downloaded in this path?
    notify_on_move bool
    Trigger on files moved to this path?
    notify_on_upload bool
    Trigger on files created/uploaded/updated/changed in this path?
    notify_user_actions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    send_interval string
    The time interval that notifications are aggregated to
    subject string
    Custom subject line to use for notification emails
    suppressed_email bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    trigger_by_share_recipients bool
    Notify when actions are performed by a share recipient?
    triggering_filenames list(string)
    Array of filenames (possibly with wildcards) to scope trigger
    triggering_group_ids list(number)
    If set, will only notify on actions made by a member of one of the specified groups
    triggering_user_ids list(number)
    If set, will only notify on actions made one of the specified users
    unsubscribed bool
    Is the user unsubscribed from this notification?
    unsubscribed_reason string
    The reason that the user unsubscribed
    user_id number
    Notification user ID
    username string
    Notification username
    workspace_id number
    Workspace ID. 0 means the default workspace.
    groupId Integer
    ID of Group to receive notifications
    groupIds List<Integer>
    Group IDs when the notification requires multiple groups
    groupName String
    Group name, if a Group ID is set
    groupNames List<String>
    Group names when the notification requires multiple groups
    message String
    Custom message to include in notification emails
    notifyOnCopy Boolean
    Trigger on files copied to this path?
    notifyOnDelete Boolean
    Trigger on files deleted in this path?
    notifyOnDownload Boolean
    Trigger on files downloaded in this path?
    notifyOnMove Boolean
    Trigger on files moved to this path?
    notifyOnUpload Boolean
    Trigger on files created/uploaded/updated/changed in this path?
    notifyUserActions Boolean
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path String
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive Boolean
    Apply notification recursively? This will enable notifications for each subfolder.
    sendInterval String
    The time interval that notifications are aggregated to
    subject String
    Custom subject line to use for notification emails
    suppressedEmail Boolean
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    triggerByShareRecipients Boolean
    Notify when actions are performed by a share recipient?
    triggeringFilenames List<String>
    Array of filenames (possibly with wildcards) to scope trigger
    triggeringGroupIds List<Integer>
    If set, will only notify on actions made by a member of one of the specified groups
    triggeringUserIds List<Integer>
    If set, will only notify on actions made one of the specified users
    unsubscribed Boolean
    Is the user unsubscribed from this notification?
    unsubscribedReason String
    The reason that the user unsubscribed
    userId Integer
    Notification user ID
    username String
    Notification username
    workspaceId Integer
    Workspace ID. 0 means the default workspace.
    groupId number
    ID of Group to receive notifications
    groupIds number[]
    Group IDs when the notification requires multiple groups
    groupName string
    Group name, if a Group ID is set
    groupNames string[]
    Group names when the notification requires multiple groups
    message string
    Custom message to include in notification emails
    notifyOnCopy boolean
    Trigger on files copied to this path?
    notifyOnDelete boolean
    Trigger on files deleted in this path?
    notifyOnDownload boolean
    Trigger on files downloaded in this path?
    notifyOnMove boolean
    Trigger on files moved to this path?
    notifyOnUpload boolean
    Trigger on files created/uploaded/updated/changed in this path?
    notifyUserActions boolean
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path string
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive boolean
    Apply notification recursively? This will enable notifications for each subfolder.
    sendInterval string
    The time interval that notifications are aggregated to
    subject string
    Custom subject line to use for notification emails
    suppressedEmail boolean
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    triggerByShareRecipients boolean
    Notify when actions are performed by a share recipient?
    triggeringFilenames string[]
    Array of filenames (possibly with wildcards) to scope trigger
    triggeringGroupIds number[]
    If set, will only notify on actions made by a member of one of the specified groups
    triggeringUserIds number[]
    If set, will only notify on actions made one of the specified users
    unsubscribed boolean
    Is the user unsubscribed from this notification?
    unsubscribedReason string
    The reason that the user unsubscribed
    userId number
    Notification user ID
    username string
    Notification username
    workspaceId number
    Workspace ID. 0 means the default workspace.
    group_id int
    ID of Group to receive notifications
    group_ids Sequence[int]
    Group IDs when the notification requires multiple groups
    group_name str
    Group name, if a Group ID is set
    group_names Sequence[str]
    Group names when the notification requires multiple groups
    message str
    Custom message to include in notification emails
    notify_on_copy bool
    Trigger on files copied to this path?
    notify_on_delete bool
    Trigger on files deleted in this path?
    notify_on_download bool
    Trigger on files downloaded in this path?
    notify_on_move bool
    Trigger on files moved to this path?
    notify_on_upload bool
    Trigger on files created/uploaded/updated/changed in this path?
    notify_user_actions bool
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path str
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive bool
    Apply notification recursively? This will enable notifications for each subfolder.
    send_interval str
    The time interval that notifications are aggregated to
    subject str
    Custom subject line to use for notification emails
    suppressed_email bool
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    trigger_by_share_recipients bool
    Notify when actions are performed by a share recipient?
    triggering_filenames Sequence[str]
    Array of filenames (possibly with wildcards) to scope trigger
    triggering_group_ids Sequence[int]
    If set, will only notify on actions made by a member of one of the specified groups
    triggering_user_ids Sequence[int]
    If set, will only notify on actions made one of the specified users
    unsubscribed bool
    Is the user unsubscribed from this notification?
    unsubscribed_reason str
    The reason that the user unsubscribed
    user_id int
    Notification user ID
    username str
    Notification username
    workspace_id int
    Workspace ID. 0 means the default workspace.
    groupId Number
    ID of Group to receive notifications
    groupIds List<Number>
    Group IDs when the notification requires multiple groups
    groupName String
    Group name, if a Group ID is set
    groupNames List<String>
    Group names when the notification requires multiple groups
    message String
    Custom message to include in notification emails
    notifyOnCopy Boolean
    Trigger on files copied to this path?
    notifyOnDelete Boolean
    Trigger on files deleted in this path?
    notifyOnDownload Boolean
    Trigger on files downloaded in this path?
    notifyOnMove Boolean
    Trigger on files moved to this path?
    notifyOnUpload Boolean
    Trigger on files created/uploaded/updated/changed in this path?
    notifyUserActions Boolean
    If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
    path String
    Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    recursive Boolean
    Apply notification recursively? This will enable notifications for each subfolder.
    sendInterval String
    The time interval that notifications are aggregated to
    subject String
    Custom subject line to use for notification emails
    suppressedEmail Boolean
    If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
    triggerByShareRecipients Boolean
    Notify when actions are performed by a share recipient?
    triggeringFilenames List<String>
    Array of filenames (possibly with wildcards) to scope trigger
    triggeringGroupIds List<Number>
    If set, will only notify on actions made by a member of one of the specified groups
    triggeringUserIds List<Number>
    If set, will only notify on actions made one of the specified users
    unsubscribed Boolean
    Is the user unsubscribed from this notification?
    unsubscribedReason String
    The reason that the user unsubscribed
    userId Number
    Notification user ID
    username String
    Notification username
    workspaceId Number
    Workspace ID. 0 means the default workspace.

    Import

    The pulumi import command can be used, for example:

    Notifications can be imported by specifying the id.

    $ pulumi import filescom:index/notification:Notification example_notification 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 filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial