Event Delivery Attempts

An EventDeliveryAttempt records delivery state for an EventRecord and EventTarget.

List Event Delivery Attempts

SDK Method

event_delivery_attempt.List()

Return Values

Returns a *event_delivery_attempt.Iter and an error. Range over All() to receive files_sdk.EventDeliveryAttempt 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.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_delivery_attempt "github.com/Files-com/files-sdk-go/v3/eventdeliveryattempt"
)

eventDeliveryAttemptIterator, err := event_delivery_attempt.List(files_sdk.EventDeliveryAttemptListParams{})
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 eventDeliveryAttempt, err := range eventDeliveryAttemptIterator.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(eventDeliveryAttempt)
}

Show Event Delivery Attempt

SDK Method

event_delivery_attempt.Find()

Return Values

Returns a files_sdk.EventDeliveryAttempt value and an error.

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.

EventDeliveryAttemptFindParams Fields

FieldDescription
Id
int64
Required
Event Delivery Attempt ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_delivery_attempt "github.com/Files-com/files-sdk-go/v3/eventdeliveryattempt"
)

eventDeliveryAttempt, err := event_delivery_attempt.Find(files_sdk.EventDeliveryAttemptFindParams{Id: 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
}
fmt.Println(eventDeliveryAttempt)

The EventDeliveryAttempt Object

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

AttributeDescription
Id
int64
Event Delivery Attempt ID
EventRecordId
int64
Event Record ID
EventSubscriptionId
int64
Event Subscription ID
EventTargetId
int64
Event Target ID
ActivityNotificationBatchId
int64
Shared summary ID when this event is delivered in a Slack or Teams subfolder summary. All events in a summary share its delivery outcome.
WorkspaceId
int64
Workspace ID. 0 means the default workspace or site-wide.
Status
string
Delivery status.
Possible values: queued, success, retrying, failed
AttemptNumber
int64
Number of delivery attempts made.
ResponseCode
int64
HTTP response code, if applicable.
ErrorMessage
string
Delivery error message, if applicable.
ResponseBody
string
Delivery response body, if applicable.
LatencyMs
int64
Delivery latency in milliseconds.
DeliveredAt
date-time
Successful delivery date/time.
LastAttemptedAt
date-time
Most recent attempt date/time.
NextAttemptAt
date-time
Next scheduled attempt date/time.
CreatedAt
date-time
Delivery Attempt create date/time.