1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getNotification
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 = filescom.getNotification({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_notification = filescom.get_notification(id=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.GetNotification(ctx, &filescom.LookupNotificationArgs{
    			Id: 1,
    		}, nil)
    		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 = Filescom.GetNotification.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetNotificationArgs;
    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) {
            final var exampleNotification = FilescomFunctions.getNotification(GetNotificationArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleNotification:
        fn::invoke:
          function: filescom:getNotification
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getnotification" "exampleNotification" {
      id = 1
    }
    

    Using getNotification

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

    function getNotification(args: GetNotificationArgs, opts?: InvokeOptions): Promise<GetNotificationResult>
    function getNotificationOutput(args: GetNotificationOutputArgs, opts?: InvokeOutputOptions): Output<GetNotificationResult>
    def get_notification(id: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNotificationResult
    def get_notification_output(id: pulumi.Input[Optional[int]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetNotificationResult]
    func LookupNotification(ctx *Context, args *LookupNotificationArgs, opts ...InvokeOption) (*LookupNotificationResult, error)
    func LookupNotificationOutput(ctx *Context, args *LookupNotificationOutputArgs, opts ...InvokeOption) LookupNotificationResultOutput

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

    public static class GetNotification 
    {
        public static Task<GetNotificationResult> InvokeAsync(GetNotificationArgs args, InvokeOptions? opts = null)
        public static Output<GetNotificationResult> Invoke(GetNotificationInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetNotificationResult> Invoke(GetNotificationInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOptions options)
    public static Output<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOptions options)
    public static Output<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getNotification:getNotification
      arguments:
        # arguments dictionary
    data "filescom_get_notification" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Notification ID
    Id int
    Notification ID
    id number
    Notification ID
    id Integer
    Notification ID
    id number
    Notification ID
    id int
    Notification ID
    id Number
    Notification ID

    getNotification Result

    The following output properties are available:

    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
    Id int
    Notification ID
    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
    Id int
    Notification ID
    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
    id number
    Notification ID
    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
    id Integer
    Notification ID
    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
    id number
    Notification ID
    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
    id int
    Notification ID
    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
    id Number
    Notification ID
    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.

    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