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.

PreviousCustomers NextFees

Last updated 2 months ago

Returns a list of events

Gets events, extending back 30 days, filtered by the specified path parameter.

get

/events

Authorizations

Query parameters

createdTimeobject

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

Example: createdTime[gt]=2020-09-22T12:09:44Z

endingBeforestring

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.

startingAfterstring

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: 100

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

typestring

Represents a specific event name, or a group of events using * as a wildcard. The returned list is filtered to include only matching events. You may pass either <code>type</code> or <code>types</code>, but not both.

typesstring

An array containing less than 20 specific event names. The returned list is filtered to include only matching events. You may pass either <code>type</code> or <code>types</code>, but not both.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/events' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

405

406

408

429

500

502

503

504

{
  "hasMore": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "digitalRiverVersion": "2018-04-19T00:00:00.000+00:00",
      "data": {
        "object": {},
        "previousAttributes": {}
      },
      "liveMode": true,
      "type": "charge.succeeded",
      "createdTime": {
        "nano": 0,
        "year": 2018,
        "monthValue": 8,
        "dayOfMonth": 29,
        "hour": 9,
        "minute": 12,
        "second": 33,
        "dayOfWeek": "WEDNESDAY",
        "dayOfYear": 241,
        "month": "AUGUST",
        "offset": {
          "totalSeconds": 0,
          "id": "Z",
          "rules": {
            "fixedOffset": true,
            "transitions": [],
            "transitionRules": []
          }
        }
      }
    }
  ]
}

200 OK. The response contains a <code>data</code> attribute that consists of an array. Each entry in the array is a separate event object.

Gets an event by identifier

Retrieve the details of an event by supplying its unique identifier, which you may have received in a webhook.

get

/events/{id}

Authorizations

Path parameters

idstring · uuidrequired

Event identifer