Webhooks

Webhooks provide a way to receive real-time notifications about events occurring within your Digital River account. These notifications are sent via HTTP POST requests, allowing your application to respond immediately to changes, even those not initiated through direct API interactions. Setting up one or more webhook endpoints ensures your system stays updated and synchronizes seamlessly with Digital River events, facilitating efficient and engaging app experiences.

Digital River can send webhook events that notify your application whenever an event occurs in your account. This mechanism is especially useful for events that are not triggered by a direct API request and for services that are not directly responsible for making an API request but still need to know the response to that request.

Register webhook URLs, and we will notify you of any event in your account. When the event occurs, Digital River creates an Event object.

This Event object contains all the relevant information about what happened, including the event and the associated data. Digital River then sends the Event object, via an HTTP POST request, to any endpoint URLs you have defined in your account’s Webhooks settings. You can have Digital River send a single event to many webhook endpoints.

Creates a new webhook

Creates a new webhook

post

/webhooks

Authorizations

Body

enabledboolean · default: true

Indicates whether the webhook is enabled and receives notifications.

Example: true

addressstringrequired

URL of the webhook endpoint on your server you have set up to receive webhook notifications. Webhook data is sent as JSON in the POST request body. The full event details are included and can be used directly, after parsing the JSON into an Event object.

Example: https://company.com

apiVersionstring · enum · default: default

Indicates whether to use the current default version of the API or the latest version of the API.

Example: default

Options: latest, default

transportTypestring · enum · default: HTTP

Options: HTTP, OAUTH

typesstring[]

authenticationobject

oauthobject

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/webhooks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true,"address":"https://company.com","apiVersion":"default","transportType":"HTTP","types":["order.created"],"authentication":{},"oauth":{"tokenEndPoint":"text","clientID":"text","clientSecret":"text","grantType":"password"}}'

201

400

401

403

405

406

408

409

429

500

502

503

504

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": "2025-02-23T03:21:15.043Z",
  "updatedTime": "2025-02-23T03:21:15.043Z",
  "enabled": true,
  "address": "https://company.com",
  "apiVersion": "default",
  "transportType": "HTTP",
  "types": [
    "order.created"
  ],
  "authentication": {
    "username": "text",
    "password": "text"
  },
  "oauth": {
    "tokenEndPoint": "text",
    "userName": "text",
    "password": "text",
    "clientID": "text",
    "clientSecret": "text",
    "grantType": "password"
  }
}

201 Created

Gets a webhook endpoint by ID

Retrieves the details of a webhook endpoint. Supply the unique identifier of the webhook endpoint.

get

/webhooks/{id}

Authorizations

Path parameters

idstringrequired

Webhook ID

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.digitalriver.com/webhooks/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

405

406

408

429

500

502

503

504

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": "2025-02-23T03:21:15.043Z",
  "updatedTime": "2025-02-23T03:21:15.043Z",
  "enabled": true,
  "address": "https://company.com",
  "apiVersion": "default",
  "transportType": "HTTP",
  "types": [
    "order.created"
  ],
  "authentication": {
    "username": "text",
    "password": "text"
  },
  "oauth": {
    "tokenEndPoint": "text",
    "userName": "text",
    "password": "text",
    "clientID": "text",
    "clientSecret": "text",
    "grantType": "password"
  }
}

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.

Deletes a webhook endpoint by ID

Permanently deletes a webhook endpoint. Supply the unique identifier of the webhook.

delete

/webhooks/{id}

Authorizations

Path parameters

idstringrequired

Webhook ID

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.digitalriver.com/webhooks/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

405

406

408

409

429

500

502

503

504

204

No body

204 No Content

Updates an existing webhook endpoint

Updates a existing webhook endpoint.

patch

/webhooks/{id}

Authorizations

Path parameters

idstringrequired

Webhook ID.

Body

enabledboolean · default: true

Indicate that webhook is enabled and receives notifications or is not enabled and does not receive notifications

Example: true

addressstring

URL of the webhook endpoint on your server you have set up to receive webhook notifications. Webhook data is sent as JSON in the POST request body. The full event details are included and can be used directly, after parsing the JSON into an Event object.

Example: https://company.com

apiVersionstring · enum · default: default

Indicates whether to use the current default version of the API or the latest version of the API

Example: default

Options: latest, default

transportTypestring · enum · default: HTTP

Options: HTTP, OAUTH

typesstring[]

authenticationobject

oauthobject

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.digitalriver.com/webhooks/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true,"address":"https://company.com","apiVersion":"default","transportType":"HTTP","types":["order.created"],"authentication":{},"oauth":{"tokenEndPoint":"text","clientID":"text","clientSecret":"text","grantType":"password"}}'

200

400

401

403

404

405

406

408

409

429

500

502

503

504

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": "2025-02-23T03:21:15.043Z",
  "updatedTime": "2025-02-23T03:21:15.043Z",
  "enabled": true,
  "address": "https://company.com",
  "apiVersion": "default",
  "transportType": "HTTP",
  "types": [
    "order.created"
  ],
  "authentication": {
    "username": "text",
    "password": "text"
  },
  "oauth": {
    "tokenEndPoint": "text",
    "userName": "text",
    "password": "text",
    "clientID": "text",
    "clientSecret": "text",
    "grantType": "password"
  }
}

200 OK

Returns a list of webhooks

Get all webhooks.

get

/webhooks

Authorizations

Query parameters

typestring

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

typesstring

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

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

405

406

408

429

500

502

503

504

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdTime": "2025-02-23T03:21:15.043Z",
    "updatedTime": "2025-02-23T03:21:15.043Z",
    "enabled": true,
    "address": "https://company.com",
    "apiVersion": "default",
    "transportType": "HTTP",
    "types": [
      "order.created"
    ],
    "authentication": {
      "username": "text",
      "password": "text"
    },
    "oauth": {
      "tokenEndPoint": "text",
      "userName": "text",
      "password": "text",
      "clientID": "text",
      "clientSecret": "text",
      "grantType": "password"
    }
  }
]

200 OK. A dictionary with a data property that contains an array of up to limit webhooks. Each entry in the array is a separate webhook object. If no more webhooks are available, the resulting array will be empty. This request should never return an error.