Event Delivery Attempts

An EventDeliveryAttempt records delivery state for an EventRecord and EventTarget.

List Event Delivery Attempts

SDK Function

EventDeliveryAttempt.list()

Return Object

ListIterator<EventDeliveryAttempt>

Authorization Requirement

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

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.EventDeliveryAttempt;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<EventDeliveryAttempt> eventDeliveryAttempts = EventDeliveryAttempt.list(parameters);
  for (EventDeliveryAttempt eventDeliveryAttempt : eventDeliveryAttempts.listAutoPaging()) {
    // Operate on eventDeliveryAttempt
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show Event Delivery Attempt

SDK Function

EventDeliveryAttempt.find()

Return Object

EventDeliveryAttempt

Authorization Requirement

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

Function Arguments

ArgumentDescription
id
int64
Required
Event Delivery Attempt ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.EventDeliveryAttempt;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  EventDeliveryAttempt eventDeliveryAttempt = EventDeliveryAttempt.find(id, parameters);
  // Operate on eventDeliveryAttempt
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The EventDeliveryAttempt Object

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

AttributeDescription
id
int64
Event Delivery Attempt ID
event_record_id
int64
Event Record ID
event_subscription_id
int64
Event Subscription ID
event_target_id
int64
Event Target ID
workspace_id
int64
Workspace ID. 0 means the default workspace or site-wide.
status
string
Delivery status.
Possible values: queued, success, retrying, failed
attempt_number
int64
Number of delivery attempts made.
response_code
int64
HTTP response code, if applicable.
error_message
string
Delivery error message, if applicable.
response_body
string
Delivery response body, if applicable.
latency_ms
int64
Delivery latency in milliseconds.
delivered_at
date-time
Successful delivery date/time.
last_attempted_at
date-time
Most recent attempt date/time.
next_attempt_at
date-time
Next scheduled attempt date/time.
created_at
date-time
Delivery Attempt create date/time.