Event Delivery Attempts

An EventDeliveryAttempt records delivery state for an EventRecord and EventTarget.

List Event Delivery Attempts

Endpoint

GET/event_delivery_attempts

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

curl https://app.files.com/api/rest/v1/event_delivery_attempts.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "event_record_id": 1,
    "event_subscription_id": 1,
    "event_target_id": 1,
    "workspace_id": 1,
    "status": "example",
    "attempt_number": 1,
    "response_code": 1,
    "error_message": "example",
    "response_body": "example",
    "latency_ms": 1,
    "delivered_at": "2000-01-01T01:00:00Z",
    "last_attempted_at": "2000-01-01T01:00:00Z",
    "next_attempt_at": "2000-01-01T01:00:00Z",
    "created_at": "2000-01-01T01:00:00Z"
  }
]

Show Event Delivery Attempt

Endpoint

GET/event_delivery_attempts/{id}

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.

Request Parameters

ParameterDescription
id
int64
Required		Event Delivery Attempt ID.

Example Request

curl https://app.files.com/api/rest/v1/event_delivery_attempts/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "event_record_id": 1,
  "event_subscription_id": 1,
  "event_target_id": 1,
  "workspace_id": 1,
  "status": "example",
  "attempt_number": 1,
  "response_code": 1,
  "error_message": "example",
  "response_body": "example",
  "latency_ms": 1,
  "delivered_at": "2000-01-01T01:00:00Z",
  "last_attempted_at": "2000-01-01T01:00:00Z",
  "next_attempt_at": "2000-01-01T01:00:00Z",
  "created_at": "2000-01-01T01:00:00Z"
}

The EventDeliveryAttempt Object

Some of the endpoints 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.

Example EventDeliveryAttempt Object

{
  "id": 1,
  "event_record_id": 1,
  "event_subscription_id": 1,
  "event_target_id": 1,
  "workspace_id": 1,
  "status": "example",
  "attempt_number": 1,
  "response_code": 1,
  "error_message": "example",
  "response_body": "example",
  "latency_ms": 1,
  "delivered_at": "2000-01-01T01:00:00Z",
  "last_attempted_at": "2000-01-01T01:00:00Z",
  "next_attempt_at": "2000-01-01T01:00:00Z",
  "created_at": "2000-01-01T01:00:00Z"
}