System Status

Events

The Events resource enables proactive tracking of significant occurrences within your Digital River account. Integrating with this API allows you to monitor and respond to real-time events such as order updates, payment transactions, or customer actions. This capability will enable you to automate workflows and maintain seamless operations, enhancing your ability to manage eCommerce activities efficiently.

See Events in the Digital River API documentation for more information.

Returns a list of events

get

Get all events, going back up to 30 days.

Query parameters
createdTimestring · date-timeOptional

A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:

  • gt–return values where the createdTime field is after this timestamp
  • gte–return values where the createdTime field is after or equal to this timestamp
  • lt–return values where the createdTime field is before this timestamp
  • lte–return values where the createdTime field is before or equal to this timestamp
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

typestringOptional

A string containing a specific event name, or a group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.

typesstringOptional

An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either type or types, but not both.

Responses
200
200 OK. A dictionary with a data property that contains an array of up to limit events, starting after event starting_after. Each entry in the array is a separate event object. If no more events are available, the resulting array will be empty. This request should never return an error.
application/json
get
GET /events HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdTime": "2025-07-09T04:08:08.733Z",
      "digitalRiverVersion": "2025-07-09",
      "data": {
        "object": {},
        "previousAttributes": {}
      },
      "liveMode": true,
      "type": "charge.succeeded"
    }
  ]
}

Gets an event by ID

get

Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

Path parameters
idstring · uuidRequired

Event ID

Responses
200
200 OK. Returns an event object if a valid identifier was provided. All events share a common structure. The only property that will differ is the data property. The data dictionary's values will be the same as retrieving the same object directly from the API. For example, a charge.created event will have the same information as retrieving the relevant charge would.
application/json
get
GET /events/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": "2025-07-09T04:08:08.733Z",
  "digitalRiverVersion": "2025-07-09",
  "data": {
    "object": {},
    "previousAttributes": {}
  },
  "liveMode": true,
  "type": "charge.succeeded"
}
PreviousCustomersNextFees

Last updated