LogoLogo
System Status
  • Digital River API
  • Getting started
  • Using our services
    • Local pricing
    • Item classification
    • Subscriptions
    • e-Invoicing
  • Integration options
    • Low-code checkouts
      • Implementing a Prebuilt Checkout
      • Implementing a Components checkout
      • Offering local pricing
      • Using a shipping endpoint
      • Processing subscription acquisitions
      • Adding custom fields
      • Offering store credit
      • Displaying policies and getting consent
      • Collecting e-invoice information
      • Handling completed checkout-sessions
    • Direct integrations
      • Standard flow
      • Building checkouts
        • Checking out guest and registered customers
        • Describing line items
          • Setting the price of an item
          • Managing items with shared SKU identifiers
        • Providing address information
        • Handling shipping choice
        • Tax identifiers
        • Applying a discount
        • Setting the customer type
        • Providing the IP address
        • Selecting a currency
        • Initiating a charge
        • Setting the purchase location
        • Configuring taxes
        • Accessing regulatory fee information
        • Localizing invoices and credit memos
        • Providing an upstream identifier
        • Applying store credit
        • Handling e-invoicing requirements
        • Landed cost
        • Tax calculation inputs
        • Selling entities
        • Payment sessions
        • Applying store credit (legacy)
        • Country specs
      • Building payment workflows
        • Handling redirect payment methods
        • Handling delayed payment methods
      • Subscription acquisitions
        • Handling subscription acquisitions
        • Handling external subscription acquisitions
        • Subscription information
      • Digital River coordinated fulfillments
        • Checking inventory levels
        • Using shipping quotes
        • Reserving inventory items
        • Managing a fulfillment order
        • Cancelling a fulfillment order
    • Connectors
  • Order management
    • Processing orders
    • Handling a rejected order
    • Accessing invoices and credit memos
    • Fulfilling goods and services
    • Capturing and cancelling charges
    • Payment reauthorizations
    • Handling reversals
      • Return basics
        • Digital River coordinated returns
        • Third party coordinated returns
      • Refund basics
        • Issuing refunds
        • Refunding asynchronous payment methods
      • Disputes and chargebacks
    • Customer notifications
    • Responding to events
      • Events
        • Key event types
        • All event types
      • Webhooks
        • Creating a webhook
        • Digital River API safelist
        • Digital River signature
      • Expanding events
      • Preventing webhooks from getting disabled
    • Distributor model
  • Subscription Management
    • Managing a subscription
    • Managing an external subscription
  • Payments
    • Payment solutions
      • Drop-in payments
        • How Drop-in payments work
        • Drop-in payments integration guide
      • DigitalRiver.js with Elements
        • Elements integration guide
        • Configuring payment methods
          • Configuring Afterpay
          • Configuring Alipay+ (cross-border)
          • Configuring Alipay (domestic)
          • Configuring Amazon Pay
          • Configuring Apple Pay
          • Configuring Bancontact
          • Configuring BNP Paribas
          • Configuring BLIK
          • Configuring CCAvenue
          • Configuring Clearpay
          • Configuring Credit Cards
          • Configuring FPX Online Banking
          • Configuring Google Pay
          • Configuring iDEAL
          • Configuring Klarna
          • Configuring Konbini
          • Configuring Online Banking (IBP)
          • Configuring Online Banking (Korea Bank Transfer)
          • Configuring PayCo
          • Configuring PayPal
          • Configuring SEPA Direct Debit
          • Configuring Trustly
          • Configuring Wire Transfer
          • Common payment sources
          • Common payment objects
    • Supported payment methods
      • Afterpay
      • Alipay (domestic)
      • Alipay+ (cross-border)
      • Amazon Pay
      • Apple Pay
      • Bancontact
      • BNP Paribas
      • BLIK
      • CCAvenue
      • Clearpay
      • Credit Cards
      • FPX Online Banking
      • Google Pay
      • iDEAL
      • Klarna
      • Konbini
      • Korea Bank Transfer (Online Banking)
      • Online Banking (IBP)
      • Pay with Installments France
      • PayCo
      • PayPal
      • PayPal Billing Agreement
      • PayPal Credit
      • PayPal Pay in 3
      • PayPal Pay in 4
      • PayPal RatenZahlung (Installment Payment)
      • SEPA Direct Debit
      • Trustly
      • Wire Transfer
    • Source basics
      • Managing sources
      • Handling credit card sources
      • Retrieving sources
    • Authorization declines
    • PSD2 and SCA
      • How to ensure SCA compliance
    • Payment testing scenarios
  • Product management
    • Product basics
    • Managing SKUs
    • Using product details
    • Grouping SKUs
    • SKU-inventory item pairs
    • Managing inventory items
    • Regulatory fees
      • What are regulatory fees?
        • Fees terminology
        • Regulatory fee management
        • European regulatory fees
        • Compliance obligations
        • WEEE directive requirements
        • Copyright directive requirements
        • Compliance challenges
      • Managing regulatory fees
  • Customer management
    • Customer basics
    • Creating and updating customers
    • Setting up tax exemptions
    • Recording a customer's request to be forgotten
  • Financial reporting
    • Financials basics
    • Sales transactions
      • Returning a list of sales transactions
      • Getting a sales transaction by ID
    • Sales summaries
      • Returning a list of sales summaries
      • Getting a sales summary by ID
    • Payouts
      • Returning a list of payouts
      • Getting a payout by ID
      • Get a list of transactions included in payout by ID
  • Developer resources
    • Digital River API reference
    • DigitalRiver.js reference
      • Including DigitalRiver.js
      • Initializing DigitalRiver.js
      • DigitalRiver object
      • Elements
        • Amazon Pay element
        • Apple Pay elements
        • Google Pay elements
        • IBAN element
        • iDEAL element
        • Konbini elements
        • Compliance element
        • Offline Refund elements
        • Online Banking elements
        • Tax Identifier element
        • Invoice attribute element
        • Delayed Payment Instructions element
        • PayPal elements
      • Guidelines for capturing payment details
      • Security
      • Digital River payment objects
      • Error types, codes, and objects
    • DigitalRiverCheckout.js reference
      • Including DigitalRiverCheckout.js
      • Initializing DigitalRiverCheckout.js
        • DigitalRiverCheckout configuration object
      • DigitalRiverCheckout object
        • Configuring Prebuilt Checkout
          • Performing actions
          • Defining experience
        • Components
          • Configuring components
          • Address component
          • Shipping component
          • Tax identifier component
          • Invoice component
          • Wallet component
          • Payment component
          • Compliance component
          • Order summary component
          • Thank you component
        • Rendering a checkout button
          • Performing actions on the checkout button
        • Determining the checkout's status
      • Accessing country and currency
    • DynamicPricing.js reference
    • Postman collection
  • administration
    • Sign in
    • Digital River Dashboard
      • Digital River Dashboard quick start guide
      • Key features
      • Reset your password
      • Test and production environments
      • Account
        • Adding an account
        • Switching accounts
        • Account access
      • Profile settings
        • Viewing your personal information
        • Changing your password
        • Updating your phone number
        • Enabling multi-factor authentication
      • Finance
        • Payouts
          • Viewing your payout details
          • Filtering your payouts
          • Exporting your payouts
        • Sales summaries
          • Viewing your sales summaries details
          • Filtering your sales summaries
          • Exporting your sales summaries
          • Exporting your sales summary details
        • Transactions
          • Viewing your transaction details
          • Filtering your transactions
          • Exporting your transactions
      • Order management
        • Orders
          • Searching for orders
          • Filtering your orders
          • Viewing the order details
          • Cancelling items
          • Fulfilling items
          • Downloading an invoice
          • Downloading a credit memo
          • Creating shipping labels
          • Recording a customer's request to be forgotten
          • Viewing returns and refunds
          • Creating a return
          • Accepting a return
          • Creating a refund
          • Viewing the order's timeline
        • Checkouts
          • Searching for checkouts
          • Filtering your checkouts
          • Viewing the checkout details
        • Prebuilt Checkout links
          • Generate Prebuilt Checkout links
          • View and work with Prebuilt Checkout link details
          • Add a customer during Prebuilt Checkout
          • Add a product during Prebuilt Checkout
      • Customers
        • Viewing customer details
        • Searching for customers
        • Filtering your customers
        • Editing account information
        • Adding a customer
        • Tax IDs and certificates
          • Adding a tax certificate
          • Adding a tax ID
          • Deleting a tax ID
        • Metadata
          • Adding metadata
          • Editing metadata
        • Manage subscriptions from the Customer Details page
        • Disabling a customer
        • Recording a customer's request to be forgotten
        • Deleting a customer
      • Catalog
        • SKUs
          • Viewing the SKU details
          • Searching for SKUs
          • Filtering your SKUs
          • Adding a SKU
          • Editing a SKU
          • Deleting a SKU
          • Adding a fee to a SKU
          • Editing a fee
          • Deleting a fee
          • Viewing product tariff codes
        • Managing customer subscriptions from Digital River Dashboard
      • Developers
        • API keys
          • Updating your API version
          • Getting your API keys
          • Changing the API version for your key
          • Creating a restricted key
          • Editing a restricted key
          • Deleting a restricted key
          • Rotating keys
        • Webhooks
          • Creating a webhook
          • Editing a webhook
          • Deleting a webhook
          • Rotating a webhook's secret
        • API logs
          • Filtering the API log
          • Viewing the API log details
        • Event logs
          • Filtering the events log
          • Viewing the event details
      • Settings
        • Users and roles
          • Roles
          • Searching for a user by name or email
          • Filtering your users and roles
          • Adding a user
          • Editing a user
          • Deleting a user
        • Prebuilt Checkout
        • Payment methods
          • Viewing your payment methods
          • Viewing payment method details
            • Enabling currencies
            • Managing countries
          • Enabling or disabling a payment method
  • General Resources
    • eCompass
    • eCompass documentation
    • Release notes
      • 2024
      • 2023
      • 2022
      • 2021
      • 2020
      • 2019
    • Standards and certifications
      • Certification process
      • Compliance requirements
      • Documentation requirements
      • Integration checklists
        • Admin portal
        • Products and SKUs
        • Customers and tax exemptions
        • Checkouts, payment sources, and orders
        • Disclosures, compliance statements, and emails
        • Fulfillments and cancellations
        • Customer portal
        • Order refund synchronization
        • Reversals
        • Error handling
      • Test and use cases
    • Commerce infrastructure
    • Versioning
    • Glossary
Powered by GitBook
On this page
  • Account management events
  • Checkout-related events
  • Customer management events
  • Fee management events
  • File link management events
  • Fulfiller management events
  • Fulfillment management events
  • Invoice events
  • Invoice attribute events
  • Location management events
  • Logistics events
  • Manufacturer management events
  • Order events
  • Payout events
  • Plan events
  • Refund events
  • Return events
  • Sales transaction events
  • SKU management events
  • Source events
  • Subscription events
  • Tax identifier management events
  1. Order management
  2. Responding to events
  3. Events

All event types

Learn about all event types based on service or feature.

PreviousKey event typesNextWebhooks

Last updated 2 months ago

Read this topic to learn about all available event types. The following sections provide the names and descriptions of available event types based on service or feature.

Account management events

  • account.update.failure: Occurs whenever an account update fails.

  • account.update.success: Occurs whenever an account update succeeds.

Checkout-related events

  • checkout.created: Occurs whenever a checkout is created.

  • checkout.deleted: Occurs whenever a checkout is deleted.

  • checkout.updated: Occurs whenever a checkout is updated.

  • checkout_session.order.create: Occurs from the orchestration service when an order is successfully created using a checkout session. The orchestration service will provide the full payload required to publish the event externally. This event requires no additional API requests to be made.

Customer management events

  • customer.created: Occurs whenever a customer is created.

  • customer.deleted: Occurs whenever a customer is deleted.

  • customer.invoice_attribute.created: Occurs when an invoice attribute is attached to a customer.

  • customer.source.created:Occurs whenever a source is attached to a customer.

  • customer.source.deleted:Occurs whenever a source is detached from a customer.

  • customer.tax_identifier.created:Occurs whenever a tax identifier is attached to a customer.

  • customer.updated:Occurs whenever a customer is updated.

Fee management events

  • fee.created: Occurs whenever a fee is created.

  • fee.deleted: Occurs whenever a fee is deleted.

  • fee.updated: Occurs whenever a fee is updated.

File link management events

  • fileLink.created: Occurs whenever a file link is created.

  • fileLink.deleted: Occurs whenever a file link is deleted.

  • fileLink.updated: Occurs whenever a file link is updated.

Fulfiller management events

  • fulfiller.created: Occurs when a fulfiller is created.

  • fulfiller.deleted: Occurs when a fulfiller is deleted.

  • fulfiller.updated: Occurs when a fulfiller is updated.

Fulfillment management events

  • fulfillment.create: Occurs whenever an order item or an entire order is fulfilled by GF (Global Fulfillment) or a third party.

  • fulfillment_cancellation.accepted: Occurs when GF is notified that the fulfillment location has approved canceled products.

  • fulfillment_cancellation.created: Occurs when a cancel request notification is sent to GF and has not yet been approved or rejected by the fulfillment location.

  • fulfillment_cancellation.rejected: Occurs when GF is notified that the fulfillment location has rejected canceled products.

  • fulfillment_order.backordered: Occurs when GF receives a fulfillment status notice (status: back-ordered) from a channel's fulfiller.

  • fulfillment_order.cancelled: Occurs when cancellation is auto-approved or cancellation request is approved through GFCC or fulfillment cancellation response.

  • fulfillment_order.pending: Occurs when a sales order is enqueued for creation at GF

  • fulfillment_order.shipped: Occurs when GF receives a shipment notification from a channel's fulfiller.

  • fulfillment_return.accepted: Occurs when GF is notified that the fulfillment location has received returned products.

  • fulfillment_return.created: Occurs when a return request notification is sent to GF and has not yet been approved or rejected by the fulfillment location.

  • fulfillment_return.pending: Occurs when GF is notified that the fulfillment location has approved a return but is waiting in a pending state to be received at the warehouse.

  • fulfillment_return.rejected: Occurs when GF is notified that the fulfillment location has rejected the return.

Invoice events

  • invoice.created: Occurs whenever an invoice is created.

  • invoice.open: Occurs whenever an invoice is opened.

  • invoice.paid: Occurs whenever an invoice is paid.

  • invoice.payment_failed: Occurs when an invoice is failed to capture the payment

  • invoice.uncollectible: Occurs whenever an invoice state becomes uncollectible at the end of the payment collection period.

  • invoice.updated: Occurs whenever an invoice is updated.

  • invoice.void: Occurs whenever an invoice is void.

Invoice attribute events

  • invoice_attribute.created: Occurs when an invoice attribute is created.

  • invoice_attribute.deleted: Occurs when an invoice attribute is deleted.

Location management events

  • location.created: Occurs when a location is created.

  • location.deleted: Occurs when a location is deleted.

  • location.updated: Occurs when a location is updated.

Logistics events

  • logistics_return.received: Occurs when Global Logistics (GL) receives notification from a logistics partner that a return shipment has been received and accepted.

Manufacturer management events

  • manufacturer.created: Occurs whenever a manufacturer is created.

  • manufacturer.deleted: Occurs whenever a manufacturer is deleted.

  • manufacturer.updated:Occurs whenever a manufacturer is updated.

Order events

  • order.blocked: Occurs whenever an order is blocked (e.g., the customer is a denied person) or is blocked by fraud.

  • order.cancelled: Occurs whenever an order is canceled.

  • order.charge.cancel.complete: Occurs whenever an order charge cancel is completed.

  • order.charge.cancel.failed: Occurs whenever an order charge cancellation has failed.

  • order.charge.cancel.pending: Occurs whenever an order charge cancellation is initiated.

  • order.charge.cancel.pending_information: Occurs whenever an order charge cancel is initiated and awaiting information.

  • order.charge.cancelled: Occurs whenever an order has all its charges canceled.

  • order.charge.capturable: Occurs whenever an order charge becomes capturable

  • order.charge.capture.complete: Occurs whenever an order charge capture is completed.

  • order.charge.capture.completed: Occurs whenever an order charge capture completes. Replaced succeeded with completed.

  • order.charge.capture.created: Occurs whenever a charge capture for all or part of an order charge is created.

  • order.charge.capture.failed: Occurs whenever a payment (charge capture for all or part of an order) charge fails.

  • order.charge.capture.pending: Occurs whenever an order charge capture is made.

  • order.charge.complete: Occurs whenever an order charge is complete

  • order.charge.completed: Occurs whenever an order charge is complete

  • order.charge.created: Occurs whenever an order charge is created.

  • order.charge.failed: Occurs whenever an order charge fails.

  • order.charge.pending: Occurs whenever an order charge is created.

  • order.charge.reauth.failed: Occurs when the reAuth fails during fulfillment

  • order.charge.refund.complete: Occurs whenever an order charge refund is completed.

  • order.charge.refund.completed: Occurs whenever an order charge refund completes

  • order.charge.refund.created: Occurs whenever an order charge refund is created

  • order.charge.refund.failed: Occurs whenever an order charge refund fails

  • order.charge.refund.pending: Occurs whenever an order charge refund is created

  • order.chargeback: Occurs whenever a chargeback Sales Transaction is created.

  • order.complete: Occurs whenever an order is both fulfilled and captured.

  • order.created: Occurs whenever an order is created.

  • order.credit_memo.created: Occurs whenever an order credit memo is created

  • order.dispute: Occurs whenever an order gets disputed.

  • order.dispute.resolved: Occurs whenever an order Dispute gets resolved.

  • order.fulfilled: Occurs whenever all items in an order have been fulfilled (by GF, a third party, or both).

  • order.invoice.created: Occurs when an order invoice is created.

  • order.pending_payment: Occurs whenever an order is pending funds.

  • order.refunded: Occurs whenever an order is refunded in part or in full.

  • order.review_closed: Occurs whenever an order passes fraud or DPL review.

  • order.review_opened: Occurs whenever an order enters fraud or DPL review

  • order.submitted: Occurs whenever an order is submitted.

  • order.updated: Occurs whenever an order is updated except for SKU item metadata, which won't generate order update events.

Payout events

  • payout.created: Occurs whenever a payout gets created.

Plan events

  • plan.created: Occurs whenever a plan is created.

  • plan.deleted: Occurs whenever a plan is deleted.

  • plan.updated: Occurs whenever a plan is updated.

Refund events

  • refund.complete: Occurs whenever a refund occurs for all or part of an order.

  • refund.created: Occurs whenever a refund is created for all or part of an order

  • refund.failed: Occurs whenever an order refund fails.

  • refund.pending: Occurs whenever a refund is made.

  • refund.pending_information: Occurs whenever a refund needs additional information for processing.

  • refund.succeeded: Occurs whenever a refund occurs for all or part of an order.

  • refund.updated: Occurs whenever the metadata for a refund is updated.

Return events

  • return.accepted: Occurs whenever a return is accepted (all items defined in the return).

  • return.created: Occurs whenever a return is created, including partial returns.

  • return.updated: Occurs whenever the metadata for a return is updated.

Sales transaction events

  • sales_transaction.created: Occurs whenever a sales transaction gets created.

SKU management events

  • sku.created: Occurs whenever a SKU is created.

  • sku.deleted: Occurs whenever a SKU is deleted.

  • sku.updated: Occurs whenever a SKU is updated.

Source events

  • source.chargeable: Occurs whenever a source transitions to chargeable.

  • source.created: Occurs whenever a source is created.

Subscription events

  • subscription.created: Occurs whenever a subscription is created.

  • subscription.deleted: Occurs whenever a subscription is deleted.

  • subscription.extended: Occurs whenever the subscription is renewed successfully.

  • subscription.failed: Occurs whenever a subscription is failed.

  • subscription.payment_failed: Occurs when we send payment failure to the customer.

  • subscription.reminder: Occurs when we send the customer a renewal reminder.

  • subscription.updated: Occurs whenever a subscription is updated.

Tax identifier management events

  • tax_identifier.deleted: Occurs whenever a tax identifier is deleted.

  • tax_identifier.not_valid: Occurs whenever the state of tax identifier is changed to not_valid.

  • tax_identifier.pending: Occurs whenever the state of tax identifier is changed to pending.

  • tax_identifier.updated: Occurs whenever the content of a tax-identifier is updated (except state).

  • tax_identifier.verified: Occurs whenever the state of a tax-identifier is changed to verified.

If you're using Digital River's account management service, you'll most likely want to to listen for the following of :

If you're using Digital River's checkout service, you'll most likely want to to listen for the following of :

If you're using Digital River's customer management service, you'll most likely want to to listen for the following oof :

If you're using fees in your transactions, you'll most likely want to to listen for the following of :

If you're using file links in your transactions (for example, Prebuilt checkouts), you'll most likely want to to listen for the following of :

If you're managing order fulfillers, you'll most likely want to to listen for the following oof :

If you're managing order fulfillment, you'll most likely want to to listen for the following of :

If you're monitoring invoice status, you'll most likely want to to listen for the following of :

If you're monitoring invoice attributes, you'll most likely want to to listen for the following of :

If you're managing locations, you'll most likely want to to listen for the following of :

If you're monitoring logistic returns status, you'll most likely want to to listen for the following of :

If you're managing manufacturer information, you'll most likely want to k to listen for the following of :

If you're monitoring order status, payments, charges, refunds, and more, you'll most likely want to to listen for the following of :

: Occurs whenever an order is submitted.

If you're monitoring payout status, you'll most likely want to to listen for the following oof :

If you're monitoring plan status, you'll most likely want to to listen for the following of :

If you're monitoring the status of refunds, you'll most likely want to to listen for the following of :

If you're monitoring the status of returns, you'll most likely want to to listen for the following of :

If you're monitoring sales transactions, you'll most likely want to to listen for the following of :

If you're monitoring SKUs, you'll most likely want to to listen for the following of :

If you're monitoring source status, you'll most likely want to to listen for the following of :

If you're monitoring the status of , you'll most likely want to to listen for the following of :

: Occurs when the subscription grace date is past or equal to the lapse event date.

: Occurs when a source_not_supported error occurs on renewal of subscription.

If you're managing tax identifier status and information, you'll likely want to to listen for the following of :

Account management events
Checkout-related events
Customer management events
Fee management events
File link events
Fulfiller management events
Fulfillment management events
Invoice events
Invoice attribute events
Location management events
Logistics events
Manufacturer management events
Order events
Payout events
Plan events
Refund events
Return events
Sales transaction events
SKU management events
Source events
Subscription events
Tax identifier management events
configure a webhook(s)
configure a webhook(s)
configure a webhook(s)
configure a webhook(s)
configure a webhook(s)
configure a webhook(s)
configure a webhook(s)
configure a webhook(s)
configure a webhook
configure a webhook(s)
configure a webhook
configure a webhoo
configure webhook
configure webhook
configure webhook
configure webhook
configure webhook
configure webhook
configure webhook
configure webhook
subscriptions
configure webhook
configure webhook
types
types
types
types
types
types
types
types
types
types
type(s)
types
types
types
types
types
types
types
types
types
types
types
subscription.lapsed
subscription.source_invalid
order.accepted
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events
events