Webhooks

allow your applications to receive real-time notifications from Digital River whenever certain events occur in your account. By configuring webhook URLs, your systems can be automatically alerted with detailed information, enabling timely and efficient responses to significant activities without continuous polling. This capability ensures your application remains in sync with account events, enhancing integration and operational workflow.

PreviousSources

Last updated 3 months ago

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

cURL

JavaScript

Python

HTTP

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

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "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"
    },
    "createdTime": {
      "nano": 1000000,
      "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": []
        }
      }
    },
    "updatedTime": {
      "nano": 1000000,
      "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. 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.

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

cURL

JavaScript

Python

HTTP

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  },
  "createdTime": {
    "nano": 1000000,
    "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": []
      }
    }
  },
  "updatedTime": {
    "nano": 1000000,
    "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": []
      }
    }
  }
}

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

cURL

JavaScript

Python

HTTP

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  },
  "createdTime": {
    "nano": 1000000,
    "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": []
      }
    }
  },
  "updatedTime": {
    "nano": 1000000,
    "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. 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

cURL

JavaScript

Python

HTTP

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

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

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

cURL

JavaScript

Python

HTTP

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  },
  "createdTime": {
    "nano": 1000000,
    "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": []
      }
    }
  },
  "updatedTime": {
    "nano": 1000000,
    "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