Manage webhook events

Get all webhook subscriptions

Retrieve all webhook subscriptions.

GEThttps://api.digitalriver.com/webhooks

Query parameters

Header parameters

Response

200401403404

OK

Body

application/json

idstring (uuid)

createdTimestring (date-time)

Time at which the webhook was created

updatedTimestring (date-time)

Time at which the webhook was updated

typesarray of string

apiVersionenum

Indicates whether the webhook is configured for the current, default version of the API or the version specified by YYYY-MM-DD.

Example: "default"

default<YYYY-MM-DD>

enabledboolean

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"

transportTypeenum

HTTPOAUTH

oauthobject

authenticationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/webhooks', {
    method: 'GET',
    headers: {
      "x-webhook-account-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdTime": {
      "offset": {
        "totalSeconds": 0,
        "id": "Z",
        "rules": {
          "transitions": [],
          "transitionRules": [],
          "fixedOffset": true
        }
      },
      "nano": 1000000,
      "year": 2018,
      "monthValue": 8,
      "dayOfMonth": 29,
      "hour": 9,
      "minute": 12,
      "second": 33,
      "month": "AUGUST",
      "dayOfWeek": "WEDNESDAY",
      "dayOfYear": 241
    },
    "updatedTime": {
      "offset": {
        "totalSeconds": 0,
        "id": "Z",
        "rules": {
          "transitions": [],
          "transitionRules": [],
          "fixedOffset": true
        }
      },
      "nano": 1000000,
      "year": 2018,
      "monthValue": 8,
      "dayOfMonth": 29,
      "hour": 9,
      "minute": 12,
      "second": 33,
      "month": "AUGUST",
      "dayOfWeek": "WEDNESDAY",
      "dayOfYear": 241
    },
    "types": [
      "order.created"
    ],
    "apiVersion": "default",
    "enabled": true,
    "address": "https://company.com",
    "transportType": "HTTP",
    "oauth": {
      "tokenEndPoint": "text",
      "userName": "text",
      "password": "text",
      "clientID": "text",
      "clientSecret": "text",
      "grantType": "password"
    },
    "authentication": {
      "username": "text",
      "password": "text"
    }
  }
]

Create a new webhook

Create a webhook.

POSThttps://api.digitalriver.com/webhooks

Header parameters

Body

application/json

Webhook Creation Request

typesarray of string

apiVersionenum

Indicates whether to use the current, default version of the API or the version specified by YYYY-MM-DD.

Example: "default"

default<YYYY-MM-DD>

enabledboolean

Indicates whether the webhook is enabled and receives notifications.

Example: true

address*string

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"

transportTypeenum

HTTPOAUTH

oauthobject

authenticationobject

Response

200201400401403404

OK

Body

application/json

idstring (uuid)

createdTimestring (date-time)

Time at which the webhook was created

updatedTimestring (date-time)

Time at which the webhook was updated

typesarray of string

apiVersionenum

Indicates whether the webhook is configured for the current, default version of the API or the version specified by YYYY-MM-DD.

Example: "default"

default<YYYY-MM-DD>

enabledboolean

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"

transportTypeenum

HTTPOAUTH

oauthobject

authenticationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/webhooks', {
    method: 'POST',
    headers: {
      "x-webhook-account-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "https://company.com"
    }),
});
const data = await response.json();

Response

200201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 1000000,
    "year": 2018,
    "monthValue": 8,
    "dayOfMonth": 29,
    "hour": 9,
    "minute": 12,
    "second": 33,
    "month": "AUGUST",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 241
  },
  "updatedTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 1000000,
    "year": 2018,
    "monthValue": 8,
    "dayOfMonth": 29,
    "hour": 9,
    "minute": 12,
    "second": 33,
    "month": "AUGUST",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 241
  },
  "types": [
    "order.created"
  ],
  "apiVersion": "default",
  "enabled": true,
  "address": "https://company.com",
  "transportType": "HTTP",
  "oauth": {
    "tokenEndPoint": "text",
    "userName": "text",
    "password": "text",
    "clientID": "text",
    "clientSecret": "text",
    "grantType": "password"
  },
  "authentication": {
    "username": "text",
    "password": "text"
  }
}

Get a specific webhook by ID

Retrieve a webhook with a specific ID by including the ID {webhookId} in the URI path parameter.

GEThttps://api.digitalriver.com/webhooks/{webhookId}

Path parameters

webhookId*string (uuid)

Provide the webhook's ID in UUID format.

Header parameters

Response

200401403404

OK

Body

application/json

idstring (uuid)

createdTimestring (date-time)

Time at which the webhook was created

updatedTimestring (date-time)

Time at which the webhook was updated

typesarray of string

apiVersionenum

Indicates whether the webhook is configured for the current, default version of the API or the version specified by YYYY-MM-DD.

Example: "default"

default<YYYY-MM-DD>

enabledboolean

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"

transportTypeenum

HTTPOAUTH

oauthobject

authenticationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/webhooks/{webhookId}', {
    method: 'GET',
    headers: {
      "x-webhook-account-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 1000000,
    "year": 2018,
    "monthValue": 8,
    "dayOfMonth": 29,
    "hour": 9,
    "minute": 12,
    "second": 33,
    "month": "AUGUST",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 241
  },
  "updatedTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 1000000,
    "year": 2018,
    "monthValue": 8,
    "dayOfMonth": 29,
    "hour": 9,
    "minute": 12,
    "second": 33,
    "month": "AUGUST",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 241
  },
  "types": [
    "order.created"
  ],
  "apiVersion": "default",
  "enabled": true,
  "address": "https://company.com",
  "transportType": "HTTP",
  "oauth": {
    "tokenEndPoint": "text",
    "userName": "text",
    "password": "text",
    "clientID": "text",
    "clientSecret": "text",
    "grantType": "password"
  },
  "authentication": {
    "username": "text",
    "password": "text"
  }
}

Delete a webhook

Delete a webhook with a specific ID by including the {webhookId} in the URI path parameter.

DELETEhttps://api.digitalriver.com/webhooks/{webhookId}

Path parameters

webhookId*string (uuid)

Provide the webhook's ID in UUID format.

Header parameters

Response

200204401403404

OK

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/webhooks/{webhookId}', {
    method: 'DELETE',
    headers: {
      "x-webhook-account-id": "text"
    },
});
const data = await response.json();

Update a webhook

Update a webhook with a specific ID by including the {webhookId} in the URI path parameter.

PATCHhttps://api.digitalriver.com/webhooks/{webhookId}

Path parameters

webhookId*string (uuid)

Provide the webhook's ID in UUID format.

Header parameters

Body

application/json

updateRequest

typesarray of string

apiVersionenum

Indicates whether to use the current, default version of the API or the version specified by YYYY-MM-DD.

Example: "default"

default<YYYY-MM-DD>

enabledboolean

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"

transportTypeenum

HTTPOAUTH

oauthobject

authenticationobject

Response

200201204400401403

OK

Body

application/json

idstring (uuid)

createdTimestring (date-time)

Time at which the webhook was created

updatedTimestring (date-time)

Time at which the webhook was updated

typesarray of string

apiVersionenum

Indicates whether the webhook is configured for the current, default version of the API or the version specified by YYYY-MM-DD.

Example: "default"

default<YYYY-MM-DD>

enabledboolean

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"

transportTypeenum

HTTPOAUTH

oauthobject

authenticationobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/webhooks/{webhookId}', {
    method: 'PATCH',
    headers: {
      "x-webhook-account-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 1000000,
    "year": 2018,
    "monthValue": 8,
    "dayOfMonth": 29,
    "hour": 9,
    "minute": 12,
    "second": 33,
    "month": "AUGUST",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 241
  },
  "updatedTime": {
    "offset": {
      "totalSeconds": 0,
      "id": "Z",
      "rules": {
        "transitions": [],
        "transitionRules": [],
        "fixedOffset": true
      }
    },
    "nano": 1000000,
    "year": 2018,
    "monthValue": 8,
    "dayOfMonth": 29,
    "hour": 9,
    "minute": 12,
    "second": 33,
    "month": "AUGUST",
    "dayOfWeek": "WEDNESDAY",
    "dayOfYear": 241
  },
  "types": [
    "order.created"
  ],
  "apiVersion": "default",
  "enabled": true,
  "address": "https://company.com",
  "transportType": "HTTP",
  "oauth": {
    "tokenEndPoint": "text",
    "userName": "text",
    "password": "text",
    "clientID": "text",
    "clientSecret": "text",
    "grantType": "password"
  },
  "authentication": {
    "username": "text",
    "password": "text"
  }
}