Event Delivery Attempts

An EventDeliveryAttempt records delivery state for an EventRecord and EventTarget.

List Event Delivery Attempts

SDK Method

\Files\Model\EventDeliveryAttempt::list;

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.

Additional Arguments

Example Request

try {
  $event_delivery_attempts = \Files\Model\EventDeliveryAttempt::list();
  foreach ($event_delivery_attempts as $event_delivery_attempt) {
    // Operate on $event_delivery_attempt
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Event Delivery Attempt

SDK Method

\Files\Model\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.

Method Arguments

ArgumentDescription
id
int64
Required		Event Delivery Attempt ID.

Example Request

try {
  $event_delivery_attempt = \Files\Model\EventDeliveryAttempt::find($id);
  // Operate on $event_delivery_attempt
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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
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.