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

action_notification_export_result.List()

Return Values

Returns a *action_notification_export_result.Iter and an error. Range over All() to receive files_sdk.ActionNotificationExportResult values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator or a Workspace Administrator for the relevant workspace.

ActionNotificationExportResultListParams Fields

FieldDescription
UserId
int64
User ID. Provide a value of 0 to operate the current session's user.
ActionNotificationExportId
int64
Required
ID of the associated action notification export.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    action_notification_export_result "github.com/Files-com/files-sdk-go/v3/actionnotificationexportresult"
)

actionNotificationExportResultIterator, err := action_notification_export_result.List(files_sdk.ActionNotificationExportResultListParams{ActionNotificationExportId: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for actionNotificationExportResult, err := range actionNotificationExportResultIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(actionNotificationExportResult)
}

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
CreatedAt
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.
RequestHeaders
string
A JSON-encoded string with headers that were sent with the webhook.
RequestMethod
string
The HTTP verb used to perform the webhook.
RequestUrl
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.