Supported Products and Event Types {#wh-fg-product-event-types} =============================================================== When you create a webhook subscription, you must include a `Cybersource` *product* and one of its corresponding *event types* in your request. You can include multiple products and event types in the same request. Every time one of the events that you subscribe to occurs, you receive a notification. If you subscribe to a product that is not enabled for your account, you receive a notification when it is enabled. To retrieve a list of the enabled products that your organization can subscribe to, see [Retrieve a List of Products and Events](/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-product-list-intro.md ""). When you send a *create a webhook subscription* request, set the productId field to a value listed in the Product ID column. Set the eventTypes field array to a value listed in the Event Types column. If you are subscribing to multiple products and event types, separate each value with the comma character (`,`). These tables contain all of the supported products, event types, and their corresponding field values: Alternative Payment Methods {#wh-fg-product-event-types_alt-pay} ---------------------------------------------------------------- | Product ID | Event Types | Description | |-----------------------------|-----------------------------|---------------------------------------------------------------------------------| | `alternativePaymentMethods` | `payments.payments.updated` | Notifies you that an alternative payment transaction's status was been updated. | Decision Manager {#wh-fg-product-event-types_dm} ------------------------------------------------ | Product ID | Event Types | Description | |-------------------|---------------------------------------|-------------------------------------------------------------| | `decisionManager` | `risk.casemanagement.decision.accept` | Notifies you that a Decision Manager case was accepted. | | `decisionManager` | `risk.casemanagement.decision.reject` | Notifies you that a Decision Manager case was rejected. | | `decisionManager` | `risk.profile.decision.reject` | Notifies you of a profile decision to reject a transaction. | `eCheck` {#wh-fg-product-event-types_echeck} -------------------------------------------- | Product ID | Event Types | Description | |------------|------------------------------|-----------------------------------------------------------| | `eCheck` | `payments.credits.accepted` | Notifies you of a successful `eCheck` credit transaction. | | `eCheck` | `payments.credits.failed` | Notifies you of an `eCheck` credit transaction failure. | | `eCheck` | `payments.payments.accepted` | Notifies you of a successful `eCheck` debit transaction. | | `eCheck` | `payments.payments.failed` | Notifies you of an `eCheck` debit transaction failure. | | `eCheck` | `payments.voids.accepted` | Notifies you of a successful `eCheck` void transaction. | | `eCheck` | `payments.voids.failed` | Notifies you of an `eCheck` void transaction failure. | `Fraud Management Essentials` {#wh-fg-product-event-types_fme} -------------------------------------------------------------- | Product ID | Event Types | Description | |-----------------------------|---------------------------------------|----------------------------------------------------------------------------------| | `fraudManagementEssentials` | `risk.casemanagement.decision.accept` | Notifies you that a `Fraud Management Essentials` case was accepted. | | `fraudManagementEssentials` | `risk.casemanagement.addnote` | Notifies you that a note has been added to a `Fraud Management Essentials` case. | | `fraudManagementEssentials` | `risk.profile.decision.reject` | Notifies you that a transaction was rejected. | | `fraudManagementEssentials` | `risk.casemanagement.decision.reject` | Notifies you that a `Fraud Management Essentials` case was rejected. | | `fraudManagementEssentials` | `risk.profile.decision.monitor` | Notifies you of a profile decision to monitor a transaction. | | `fraudManagementEssentials` | `risk.profile.decision.review` | Notifies you of a profile decision to review a transaction. | Invoicing {#wh-fg-product-event-types_invoicing} ------------------------------------------------ | Product ID | Event Types | Description | |---------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| | `customerInvoicing` | `invoicing.customer.invoice.send` | Notifies you that an invoice was sent. | | `customerInvoicing` | `invoicing.customer.invoice.cancel` | Notifies you that an invoice was cancelled. | | `customerInvoicing` | `invoicing.customer.invoice.paid` | Notifies you that an invoice was paid. | | `customerInvoicing` | `invoicing.customer.invoice.partial-payment` | Notifies you that an invoice was partially paid. | | `customerInvoicing` | `invoicing.customer.invoice.reminder` | Notifies you 5 days before the invoice payment is due. This event is triggered if you have invoice reminders enabled in your invoice settings. | | `customerInvoicing` | `invoicing.customer.invoice.overdue-reminder` | Notifies you 1 day after the invoice payment is due. This event is triggered if you have invoice reminders enabled in your invoice settings. | Pay By Link {#wh-fg-product-event-types_pbl} -------------------------------------------- | Product ID | Event Types | Description | |-------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | `payByLink` | `payByLink.customer.payment` | Merchants can subscribe to this event type to automate how their system is informed when a customer completes a payment. | | `payByLink` | `payByLink.merchant.payment` | Partner resellers can subscribe to this event type to control the distribution of the payment confirmation email sent to their merchants' customers. | Payments -------- Payment events must be enabled for your account. Contact our support team to enable the events. Payment events require message-level encryption. See [Message-Level Encryption](/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-mle-intro.md ""). | Product ID | Event Types | Description | |------------|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `payments` | `payments.capture.status.accepted` | Notifies you that a payment capture request was accepted. The transaction carries the status PENDING. | | `payments` | `payments.capture.status.updated` | Notifies you that a payment capture was updated and its status changed from PENDING to BATCHED. | | `payments` | `payments.refund.status.accepted` | Notifies you that a refund request was accepted. The transaction carries the status PENDING. | | `payments` | `payments.refund.status.updated` | Notifies you that a refund request was batched and its status has changed from PENDING to BATCHED. | | `payments` | `payments.credit.status.accepted` | Notifies you that a credit request was accepted. The transaction carries the status PENDING. | | `payments` | `payments.credit.status.updated` | Notifies you that a credit request was accepted. The transaction carries the status PENDING. | | `payments` | `payments.void.status.accepted` | Notifies you that a void request was accepted. The transaction carries the status VOIDED. | | `payments` | `payments.void.status.rejected` | Notifies you that a void request was rejected. The transaction carries the status NOT VOIDABLE. | | `payments` | `payments.authorization.status.accepted` | Notifies you that an authorization request was authorized by the issuer. The transaction carries the status AUTHORIZED. | | `payments` | `payments.authorization.status.reviewed` | Notifies you that an authorization request was under review by Decision Manager. The transaction carries the status AUTHORIZED_PENDING_REVIEW. | | `payments` | `payments.authorization.status.rejected` | Notifies you that an authorization request was declined by the issuer or failed due to server error, timeout, or invalid request. Possible statuses include INVALID_REQUEST, SERVER_ERROR, DECLINED, SERVER_TIMEOUT, or SERVICE_TIMEOUT. | | `payments` | `payments.authorization.status.partiallyApproved` | Notifies you that an authorization request was partially approved by the issuer. The transaction carries the status PARTIAL_AUTHORIZED. | | `payments` | `payments.reversal.status.accepted` | Notifies you that a reversal request was approved successfully. The transaction carries the status REVERSED. | | `payments` | `payments.reversal.status.rejected` | Notifies you that a reversal request was declined due to issuer rejection, system error, invalid request, or timeout. Possible statuses include REVERSED, INVALID_REQUEST, SERVER_ERROR, DECLINED, SERVER_TIMEOUT, or SERVICE_TIMEOUT. | Recurring Billing {#wh-fg-product-event-types_rb} ------------------------------------------------- | Product ID | Event Types | Description | |--------------------|-----------------------------------------|------------------------------------------------| | `recurringBilling` | `rbs.subscriptions.charge.failed` | Notifies you of a recurring payment failure. | | `recurringBilling` | `rbs.subscriptions.charge.pre-notified` | Notifies you of an upcoming recurring payment. | | `recurringBilling` | `rbs.subscriptions.charge.created` | Notifies you of successful recurring payment. | `Token Management Service` {#wh-fg-product-event-types_tms} ----------------------------------------------------------- | Product ID | Event Types | Description | |-------------------|--------------------------------|---------------------------------------------------------------------------------------------------------| | `tokenManagement` | `tms.networktoken.updated` | Notifies you of a network token's change in expiration date or status (suspend, resume, or deactivate). | | `tokenManagement` | `tms.networktoken.provisioned` | Notifies you when a network token provision for an instrument identifier token has been successful. | | `tokenManagement` | `tms.networktoken.binding` | Notifies you of the binding status of a network token with a device. | Unified Checkout {#wh-fg-product-event-types_uc} ------------------------------------------------ Unified Checkout events require message-level encryption. See [Message-Level Encryption](/docs/cybs/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-mle-intro.md ""). | Product ID | Event Types | Description | |-------------------|--------------------------------|---------------------------------------------------------------------------------------------------------| | `unifiedCheckout` | `uc.orders.transactionresults` | Notifies you of the payment outcome, including the full payload response from the payment service call. |