Ask or search…
K

All event types

Learn about all event types based on service or feature.
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

If you're using Digital River's account management service, you'll most likely want to configure a webhook(s) to listen for the following types of events:
  • account.update.failure: Occurs whenever an account update fails.
  • account.update.success: Occurs whenever an account update succeeds.
If you're using Digital River's checkout service, you'll most likely want to configure a webhook(s) to listen for the following types of 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

If you're using Digital River's customer management service, you'll most likely want to configure a webhook(s) to listen for the following types of 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

If you're using fees in your transactions, you'll most likely want to configure a webhook(s) to listen for the following types of 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.
If you're using file links in your transactions (for example, Prebuilt checkouts), you'll most likely want to configure a webhook(s) to listen for the following types of 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

If you're managing order fulfillers, you'll most likely want to configure a webhook(s) to listen for the following types of 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

If you're managing order fulfillments, you'll most likely want to configure a webhook(s) to listen for the following types of 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.

Global returns events

If you're monitoring global returns status, you'll most likely want to configure a webhook(s) to listen for the following types of events:
  • global_returns.accepted: Occurs when international returns are accepted.
  • global_returns.canceled: Occurs when global returns are canceled.
  • global_returns.created: Occurs when global returns are created.
  • global_returns.label.created: Occurs when global return Labels are created.
  • global_returns.scanned: Occurs when global returns are scanned.

Invoice events

If you're monitoring invoice status, you'll most likely want to configure a webhook(s) to listen for the following types of 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

If you're monitoring invoice attributes, you'll most likely want to configure a webhook to listen for the following types of events:
  • invoice_attribute.created: Occurs when an invoice attribute is created.
  • invoice_attribute.deleted: Occurs when an invoice attribute is deleted.

Location management events

If you're managing locations, you'll most likely want to configure a webhook(s) to listen for the following types of 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

If you're monitoring logistic returns status, you'll most likely want to configure a webhook to listen for the following type(s) of event(s):
  • 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

If you're managing manufacturer information, you'll most likely want to configure a webhook to listen for the following types of 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

If you're monitoring order status, payments, charges, refunds, and more, you'll most likely want to configure webhook to listen for the following types of events:
  • order.accepted: Occurs whenever an order is submitted.
  • 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

If you're monitoring payout status, you'll most likely want to configure webhook to listen for the following types of events:
  • payout.created: Occurs whenever a payout gets created.

Plan events

If you're monitoring plan status, you'll most likely want to configure webhook to listen for the following types of 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

If you're monitoring the status of refunds, you'll most likely want to configure webhook to listen for the following types of 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

If you're monitoring the status of returns, you'll most likely want to configure webhook to listen for the following types of 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

If you're monitoring sales transactions, you'll most likely want to configure webhook to listen for the following types of events
  • sales_transaction.created: Occurs whenever a sales transaction gets created.

SKU management events

If you're monitoring SKUs, you'll most likely want to configure webhook to listen for the following types of 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

If you're monitoring source status, you'll most likely want to configure webhook to listen for the following types of events
  • source.chargeable: Occurs whenever a source transitions to chargeable.
  • source.created: Occurs whenever a source is created.

Subscription events

If you're monitoring the status of subscriptions, you'll most likely want to configure webhook to listen for the following types of 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.lapsed: Occurs when the subscription grace date is past or equal to the lapse event date.
  • subscription.payment_failed: Occurs when we send payment failure to the customer.
  • subscription.reminder: Occurs when we send the customer a renewal reminder.
  • subscription.source_invalid: Occurs when a source_not_supported error occurs on renewal of subscription.
  • subscription.updated: Occurs whenever a subscription is updated.

Tax identifier management events

If you're managing tax identifier status and information, you'll likely want to configure webhook to listen for the following types of 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.