1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getActionNotificationExport
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

    An ActionNotificationExport is an operation that provides access to outgoing webhook logs. Querying webhook logs is a little different than other APIs.

    All queries against the archive must be submitted as Exports. (Even our Web UI creates an Export behind the scenes.)

    In any query field in this API, you may specify multiple values separated by commas. That means that commas

    cannot be searched for themselves, and neither can single quotation marks.

    Use the following steps to complete an export:

    1. Initiate the export by using the Create Action Notification Export endpoint. Non Site Admins must query by folder or path.

    2. Using the id from the response to step 1, poll the Show Action Notification Export endpoint. Check the status field until it is ready.

    3. You can download the results of the export as a CSV file using the resultsUrl field in the response from step 2. If you want to page through the records in JSON format, use the List Action Notification Export Results endpoint, passing the id that you got in step 1 as the actionNotificationExportId parameter. Check the X-Files-Cursor-Next header to see if there are more records available, and resubmit the same request with a cursor parameter to fetch the next page of results. Unlike most API Endpoints, this endpoint does not provide X-Files-Cursor-Prev cursors allowing reverse pagination through the results. This is due to limitations in Amazon Athena, the underlying data lake for these records.

    If you intend to use this API for high volume or automated use, please contact us with more information

    about your use case.

    Example Queries

    • History for a folder: { "queryFolder": "path/to/folder" }

    • History for a range of time: { "startAt": "2021-03-18 12:00:00", "endAt": "2021-03-19 12:00:00" }

    • History of all notifications that used GET or POST: { "queryRequestMethod": "GET,POST" }

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleActionNotificationExport = filescom.getActionNotificationExport({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_action_notification_export = filescom.get_action_notification_export(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.GetActionNotificationExport(ctx, &filescom.GetActionNotificationExportArgs{
    			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 exampleActionNotificationExport = Filescom.GetActionNotificationExport.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.GetActionNotificationExportArgs;
    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 exampleActionNotificationExport = FilescomFunctions.getActionNotificationExport(GetActionNotificationExportArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleActionNotificationExport:
        fn::invoke:
          function: filescom:getActionNotificationExport
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getactionnotificationexport" "exampleActionNotificationExport" {
      id = 1
    }
    

    Using getActionNotificationExport

    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 getActionNotificationExport(args: GetActionNotificationExportArgs, opts?: InvokeOptions): Promise<GetActionNotificationExportResult>
    function getActionNotificationExportOutput(args: GetActionNotificationExportOutputArgs, opts?: InvokeOutputOptions): Output<GetActionNotificationExportResult>
    def get_action_notification_export(id: Optional[int] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetActionNotificationExportResult
    def get_action_notification_export_output(id: pulumi.Input[Optional[int]] = None,
                                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetActionNotificationExportResult]
    func GetActionNotificationExport(ctx *Context, args *GetActionNotificationExportArgs, opts ...InvokeOption) (*GetActionNotificationExportResult, error)
    func GetActionNotificationExportOutput(ctx *Context, args *GetActionNotificationExportOutputArgs, opts ...InvokeOption) GetActionNotificationExportResultOutput

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

    public static class GetActionNotificationExport 
    {
        public static Task<GetActionNotificationExportResult> InvokeAsync(GetActionNotificationExportArgs args, InvokeOptions? opts = null)
        public static Output<GetActionNotificationExportResult> Invoke(GetActionNotificationExportInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetActionNotificationExportResult> Invoke(GetActionNotificationExportInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetActionNotificationExportResult> getActionNotificationExport(GetActionNotificationExportArgs args, InvokeOptions options)
    public static Output<GetActionNotificationExportResult> getActionNotificationExport(GetActionNotificationExportArgs args, InvokeOptions options)
    public static Output<GetActionNotificationExportResult> getActionNotificationExport(GetActionNotificationExportArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getActionNotificationExport:getActionNotificationExport
      arguments:
        # arguments dictionary
    data "filescom_get_action_notification_export" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    History Export ID
    Id int
    History Export ID
    id number
    History Export ID
    id Integer
    History Export ID
    id number
    History Export ID
    id int
    History Export ID
    id Number
    History Export ID

    getActionNotificationExport Result

    The following output properties are available:

    EndAt string
    End date/time of export range.
    ExportVersion string
    Version of the underlying records for the export.
    Id int
    History Export ID
    QueryFolder string
    Return notifications that were triggered by actions in this folder.
    QueryMessage string
    Error message associated with the request, if any.
    QueryPath string
    Return notifications that were triggered by actions on this specific path.
    QueryRequestMethod string
    The HTTP request method used by the webhook.
    QueryRequestUrl string
    The target webhook URL.
    QueryStatus string
    The HTTP status returned from the server in response to the webhook request.
    QuerySuccess bool
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    ResultsUrl string
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    StartAt string
    Start date/time of export range.
    Status string
    Status of export. Valid values: building, ready, or failed
    EndAt string
    End date/time of export range.
    ExportVersion string
    Version of the underlying records for the export.
    Id int
    History Export ID
    QueryFolder string
    Return notifications that were triggered by actions in this folder.
    QueryMessage string
    Error message associated with the request, if any.
    QueryPath string
    Return notifications that were triggered by actions on this specific path.
    QueryRequestMethod string
    The HTTP request method used by the webhook.
    QueryRequestUrl string
    The target webhook URL.
    QueryStatus string
    The HTTP status returned from the server in response to the webhook request.
    QuerySuccess bool
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    ResultsUrl string
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    StartAt string
    Start date/time of export range.
    Status string
    Status of export. Valid values: building, ready, or failed
    end_at string
    End date/time of export range.
    export_version string
    Version of the underlying records for the export.
    id number
    History Export ID
    query_folder string
    Return notifications that were triggered by actions in this folder.
    query_message string
    Error message associated with the request, if any.
    query_path string
    Return notifications that were triggered by actions on this specific path.
    query_request_method string
    The HTTP request method used by the webhook.
    query_request_url string
    The target webhook URL.
    query_status string
    The HTTP status returned from the server in response to the webhook request.
    query_success bool
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    results_url string
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    start_at string
    Start date/time of export range.
    status string
    Status of export. Valid values: building, ready, or failed
    endAt String
    End date/time of export range.
    exportVersion String
    Version of the underlying records for the export.
    id Integer
    History Export ID
    queryFolder String
    Return notifications that were triggered by actions in this folder.
    queryMessage String
    Error message associated with the request, if any.
    queryPath String
    Return notifications that were triggered by actions on this specific path.
    queryRequestMethod String
    The HTTP request method used by the webhook.
    queryRequestUrl String
    The target webhook URL.
    queryStatus String
    The HTTP status returned from the server in response to the webhook request.
    querySuccess Boolean
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    resultsUrl String
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    startAt String
    Start date/time of export range.
    status String
    Status of export. Valid values: building, ready, or failed
    endAt string
    End date/time of export range.
    exportVersion string
    Version of the underlying records for the export.
    id number
    History Export ID
    queryFolder string
    Return notifications that were triggered by actions in this folder.
    queryMessage string
    Error message associated with the request, if any.
    queryPath string
    Return notifications that were triggered by actions on this specific path.
    queryRequestMethod string
    The HTTP request method used by the webhook.
    queryRequestUrl string
    The target webhook URL.
    queryStatus string
    The HTTP status returned from the server in response to the webhook request.
    querySuccess boolean
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    resultsUrl string
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    startAt string
    Start date/time of export range.
    status string
    Status of export. Valid values: building, ready, or failed
    end_at str
    End date/time of export range.
    export_version str
    Version of the underlying records for the export.
    id int
    History Export ID
    query_folder str
    Return notifications that were triggered by actions in this folder.
    query_message str
    Error message associated with the request, if any.
    query_path str
    Return notifications that were triggered by actions on this specific path.
    query_request_method str
    The HTTP request method used by the webhook.
    query_request_url str
    The target webhook URL.
    query_status str
    The HTTP status returned from the server in response to the webhook request.
    query_success bool
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    results_url str
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    start_at str
    Start date/time of export range.
    status str
    Status of export. Valid values: building, ready, or failed
    endAt String
    End date/time of export range.
    exportVersion String
    Version of the underlying records for the export.
    id Number
    History Export ID
    queryFolder String
    Return notifications that were triggered by actions in this folder.
    queryMessage String
    Error message associated with the request, if any.
    queryPath String
    Return notifications that were triggered by actions on this specific path.
    queryRequestMethod String
    The HTTP request method used by the webhook.
    queryRequestUrl String
    The target webhook URL.
    queryStatus String
    The HTTP status returned from the server in response to the webhook request.
    querySuccess Boolean
    true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
    resultsUrl String
    If status is ready, this will be a URL where all the results can be downloaded at once as a CSV.
    startAt String
    Start date/time of export range.
    status String
    Status of export. Valid values: building, ready, or failed

    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