Action Notification Export Results

An ActionNotificationExportResult is a single record containing webhook log information that can be obtained as a part of Action Notification Export request.

List Action Notification Export Results

SDK Method

ActionNotificationExportResult.list()

Return Object

ActionNotificationExportResult[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Folder Admin permissions.

Method Arguments

ArgumentDescription
user_id
int64
User ID. Provide a value of 0 to operate the current session's user.
action_notification_export_id
int64
Required
ID of the associated action notification export.

Additional Arguments

Example Request

import ActionNotificationExportResult from 'files.com/lib/models/ActionNotificationExportResult';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const actionNotificationExportResults = await ActionNotificationExportResult.list({
    action_notification_export_id: 1,
  });
  for (const actionNotificationExportResult of actionNotificationExportResults) {
    // Operate on actionNotificationExportResult
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The ActionNotificationExportResult Object

Some of the methods above return a ActionNotificationExportResult object. The attributes of this object are listed below.

AttributeDescription
id
int64
Notification ID
created_at
int64
When the notification was sent.
status
int64
HTTP status code returned in the webhook response.
message
string
A message indicating the overall status of the webhook notification.
success
boolean
true if the webhook succeeded by receiving a 200 or 204 response.
request_headers
string
A JSON-encoded string with headers that were sent with the webhook.
request_method
string
The HTTP verb used to perform the webhook.
request_url
string
The webhook request URL.
path
string
The path to the actual file that triggered this notification. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
folder
string
The folder associated with the triggering action for this notification.