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.

The Events resource lets you know when important events occur in your account.

Returns a list of events

get

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

Authorizations
Query parameters
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

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 type or types, but not both.

typesstringOptional

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

Responses
200
200 OK. The response contains a data attribute that consists of an array. Each entry in the array is a separate event object.
application/json
get
GET /events HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Gets an event by identifier

get

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

Authorizations
Path parameters
idstring · uuidRequired

Event identifer

Responses
200
200 OK. Returns an event object if a valid identifier was provided.
application/json
get
GET /events/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Last updated