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.
Get all webhooks.
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.
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.
GET /webhooks HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdTime": "2018-08-29T09:12:33.001Z",
"updatedTime": "2018-08-29T09:12:33.001Z",
"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"
}
}
]Creates a new webhook
Each element of the array represents the name of an event type.
order.createdIndicates whether to use the current, default version of the API or the version specified by YYYY-MM-DD.
defaultExample: defaultPossible values: Indicates whether the webhook is enabled and receives notifications.
trueExample: trueURL 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.
https://company.comHTTPPossible values: POST /webhooks HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 307
{
"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"
}
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdTime": "2018-08-29T09:12:33.001Z",
"updatedTime": "2018-08-29T09:12:33.001Z",
"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"
}
}Retrieves the details of a webhook endpoint. Supply the unique identifier of the webhook endpoint.
Webhook ID
GET /webhooks/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdTime": "2018-08-29T09:12:33.001Z",
"updatedTime": "2018-08-29T09:12:33.001Z",
"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"
}
}Permanently deletes a webhook endpoint. Supply the unique identifier of the webhook.
Webhook ID
DELETE /webhooks/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Updates a existing webhook endpoint.
Webhook ID.
The name of the event type.
order.createdIndicates whether to use the current, default version of the API or the version specified by YYYY-MM-DD.
defaultExample: defaultPossible values: Indicate that webhook is enabled and receives notifications or is not enabled and does not receive notifications
trueExample: trueURL 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.
https://company.comHTTPPossible values: PATCH /webhooks/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 307
{
"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"
}
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdTime": "2018-08-29T09:12:33.001Z",
"updatedTime": "2018-08-29T09:12:33.001Z",
"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"
}
}Last updated