Extend the webhook framework
Learn how to extend the webhook framework.
Last updated
Learn how to extend the webhook framework.
Last updated
The Salesforce Lightning—Digital River Connector App comes with a webhook framework that is capable of accepting and consuming any webhook that can be configured in the Digital River . For OOTB (out-of-the-box) webhook events, see the section.
You can always extend this framework to implement custom code that will fire upon receipt of a from Digital River. The event needs to be added to the previously-created webhook in the Digital River .
To implement the custom business logic for your organization, write the subscriber code that extends the default Webhook Framework Extension point class digitalriverv3.DRB2B_WebhookHandler
.
For example, suppose you want to implement custom business logic for the event refund.pending
In your organization, create an Apex class that extends the extension point class digitalriverv3.DRB2B_WebhookHandler global with sharing class DRB2B_RefundPendingWebhook extends the digitalriverv3.DRB2B_WebhookHandler { }
Inside the class definition, override the method processWebhookEvent
of the extension point class digitalriverv3.DRB2B_WebhookHandler
. This method will have the Event Payload as one of its Input parameters.
Inside your method override, add your custom business logic. Ensure the RestResponse
status code is set to 200 as shown in the sample implementation for the refund.pending
webhook event below.
Save your class and resolve any compilation errors.
Your Apex class must be configured so that the Connector is aware and executes this Custom Webhook handler implementation whenever it receives the event refund.pending
from Digital River.
Go to the Custom Metadata Type digitalriverv3_DR_Webhook_Configuration_
Label: Refund Pending Webhook Handler
DR Webhook Configuration Name: Refund_Pending_Webhook_Handler
Webhook Event Name: refund.pending (This is the event type of the webhook.)
Webhook Handler Name: DRB2B_RefundPendingWebhook (Custom Class Name)
Click Save.
Select the event refund.pending
for the Webhook Endpoint selected in the previous step.
This section details another example of how to extend the webhook framework, this time for the refund.complete event
. In this example, an email is sent with the event payload.
mdt
and click Manage Records.
Create a new Metadata Type Record for the DR Webhook Configuration.
Set up the webhook for the Event Type refund.pending
in the .
Configure the webhook for this event by going to Webhooks and click the Webhooks endpoint that was previously configured for your organization. It will have an address of https://<<SF_My_Domain_Name>>/services/apexrest/digitalriverv3/webhooks