Webhooks
  • 31 Jan 2024
  • 7 Minutes to read
  • Dark
    Light

Webhooks

  • Dark
    Light

Article Summary

Overview

Webhooks provide a mechanism where a server-side application (In this case Stripe) can notify a client-side application (in this case Payments) when a new event (like customer create, update, delete, charge capture, charge failed, etc) has occurred on the server.

Webhooks automatically send specified data to a destination (endpoint) from database events. Our Payments app utilizes webhooks for many of our features, such as updating your Salesforce org with credit card information and creating Dispute records.

Benefits

  1. Webhook allows us to stay up-to-date by updating the card on file with any recent changes in the credit card information by major credit card companies.
  2. Allow Payouts to be received in Salesforce.
  3. After capturing the transaction, webhooks allows disputes to be created in Salesforce.
  4. Notifies/updates of any deleted payment gateway customer record or payment method.
  5. Recognize any changes in Stripe Billing subscription/Invoices.
  6. Maintains consistency of all records from Stripe into Salesforce and so on.

Instructions

Create a Force.com Domain

  1. Click the Gear Icon in the upper right-hand corner.
  2. Click Setup.
  3. Type “Sites” in the Quick Find box.
  4. Click Sites.
  5. If a Force.com domain has not been set up, continue with the instructions. Otherwise, navigate to the steps for Site Configuration.
  6. Enter a value for your Force.com domain.
  7. Click Check Availability.
  8. Review and accept the Site terms of use.
  9. Click Register My Force.com Domain.

Site Configuration

  1. Click New next to Sites.
  2. Enter a Site Label, Site Name, and a Default Web Address. (We suggest using webhook or stripe for the Site Label and Site Name.)
  3. Set Active = “TRUE”.
  4. For the Active Site Home Page field, click the Lookup icon and select “InMaintenance”. (The page is not visible. It's just a placeholder because a value is required).
  5. Click Save.

Site Edit Webhook

Assign the Blackthorn | Payments (Site Guest User) permission set to the public user

Site Guest User Permission Set Renamed

For users looking to setup Webhooks with a Payments package older than v5.6 you will need to add the Blackthorn | Payments (Webhooks) permission set. Additionally, you will need to add a Sharing Rule to allow the Site Guest User to access the Payment Gateway object.

The Blackthorn | Payments (Site Guest User) permission set is now a dual purpose permission set with packages v5.6 and beyond. This permission set will be used for webhook setup and REST API setup.

  1. Navigate back to the Site you created.
  2. Click Public Access Settings.
    H_02_21_assign site guest user per 1
  3. Click the View Users or Assign Users button.
  4. Click the link for the site guest user.
    H_02_21_assign site guest user per 2
  5. Add the Blackthorn | Payments (Site Guest User) permission set to this user's record.
  6. Click Save.
    H_02_21_assign site guest user per 3
Not seeing the Blackthorn | Payments (Site Guest User) Permission Set?

This permission set is only available in Payments packages 5.16 and later. Please upgrade to the latest version then try again.

Configure Webhooks and Add Webhook Events

Spreedly Limitation

We currently do not support webhook callbacks for Payment Gateways that are configured through Spreedly.

Configure Webhook in Stripe

  1. Navigate to your connected Stripe account dashboard. If you are creating a Webhook URL for your Stripe account in test mode, make sure the "Viewing test data" switch is on.H_02_21_configure webhook in stripe 1
  2. Select the Developers tab on the left-hand side.
  3. Click the Webhooks tab and select Add endpoint.
  4. In the Endpoint URLfield, set the URL to the Salesforce webhook Site you just created. You'll need to replace the 3 upper-case values with your org values in this URL: https://SITE_DOMAIN_NAME/SITE_PATH/services/apexrest/bt_stripe/webhook/WEBHOOK_LABEL
    • SITE_DOMAIN_NAME = The Salesforce Domain Name for the Site you set up.
    • SITE_PATH = The Path for the Site.
    • WEBHOOK_LABEL = The value in the Payment Gateway Webhook Label field.
    • NOTE: If you have multiple Stripe accounts connected to your Salesforce org and want to create a Webhook Endpoint for each in Stripe, you can use the same Salesforce Site. Change the WEBHOOK_LABEL part of the URL to the Webhook Label value on the Payment Gateway record you want to use.
  5. In Events to send, choose "receive all events".
  6. Click Add endpoint.H_02_21_configure webhook in stripe 4

URL Example

URL Template: https://SITE_DOMAIN_NAME/SITE_PATH/services/apexrest/bt_stripe/webhook/WEBHOOK_LABEL

SITE_DOMAIN_NAME = The Salesforce Domain Name for the Site you set up. To find this value, navigate to the Site record and look at the Custom URLs Related List. Use the Domain Name value. If you see more than 1 domain name, always use the one with “secure” in the name. These domains use “https” which Stripe requires.

SITE_PATH = The Path for the Site. Use the Path value from the Custom URLs Related List of the Site.

WEBHOOK_LABEL = To find this value, go to the Payment Gateway record you want to use. Use the value in the Webhook Label field.

URL Result: https://adminmethods.secure.force.com/stripe/services/apexrest/bt_stripe/webhook/test

How do I send webhooks from Stripe to Salesforce if all the retries have been exhausted?

The only solution is to manually resend the webhooks. See Stripe’s documentation for more information.

Configure Webhook in Auth.net

  1. Navigate to your connected Auth.net account dashboard.

  2. Click on Account tab | Settings | Webhooks.
    H_02_21_configure webhook authdot 1

  3. Click Add endpoint.

  4. Define a Name.

  5. Follow Step 4 from above to generate the Endpoint URL field.

  6. Set Status = Active.

  7. Under Select Events, check All Events and click Save.
    H_02_21_configure webhook authdot 2

If you have multiple Auth.net accounts connected to your Salesforce org, and want to create Webhook Endpoint for each in Auth.net, you can use the same Salesforce Site - you just need to change WEBHOOK_LABEL part of the Url to the Webhook Label value of the Payment Gateway record you want to use.

Test Webhook Connection

Test webhook connection in Stripe

Verifying in Test Mode:

  1. Select the Webhook tab on the left-hand side.
  2. Click your URL.
  3. In the top right, click Send test webhook.
    H_02_21_test webhook connection 1
  4. Set Event type = "customer.created".
  5. Click Send test webhook.
    H_02_21_test webhook connection 2

If you received a "Test webhook sent successfully" message, then Webhooks are set up correctly!

Test webhook connection in Authorize.net

  1. Click on Account tab > Settings > Webhooks.
  2. Edit the Endpoint and set the Status to "Inactive."
  3. Click Save.

You will see a Test Webhook button as shown in the below screenshot.

H_02_21_test webhook connection 3

If you received a "Ping successful" message at the top, then webhooks are set up correctly!

Verifying in Live Mode

In live mode, don’t forget to create a new URL. You can copy your Test Webhook URL, and update the Webhook Label from your live Payment Gateway record.

  1. Create a new Customer in Stripe.
  2. Click on the newly created customer record, scroll down to Events, and select the Event record.
  3. Scroll down to Webhooks.

If the Webhook record says "Success", then Webhooks are set up correctly in Production.

H_02_21_verify live mode

Adding Webhook signatures in Stripe (optional)

Webhook signatures is an additional layer of security. When setting them up, the system makes sure that the webhook event messages are not corrupted in Salesforce.

  1. Go to Stripe Dashboard | Webhooks.

  2. Select the webhook.

  3. On the Signing Secret section click Click to Reveal.
    H_02_21_add webhook sig stripe 1

  4. Navigate in your Salesforce Org to Setup | Custom Metadata Settings.

  5. Click Webhook Secret | Manage Records

  6. Click New.

  7. Enter values for LabelWebhook Secret Name, and Signing Secret.

  8. Click Save.
    H_02_21_add webhook sig stripe 2

Process Stripe Billing Webhook Types Asynchronously

A global method that allows customers to process certain Stripe Billing webhook types asynchronously instead of via the Blackthorn batch jobs was added. If the Process Async checkbox = “True”, the existing web processing batch jobs will skip those webhooks.

Blackthorn customers are responsible for adding the logic that 1) sets the records they want as Process Async and 2) calls the async method to process them. The following example code creates a before trigger to check the Process Async box and an after trigger to call the async method.

Before proceeding, two updates must be made to the Site Guest User/public user.

Step 1: To avoid permission errors, give the Blackthorn | Payments (Site Guest User) permission set Read access to the Product (Product2) object.

  1. Click the Gear icon in the upper right-hand corner.
  2. Click Setup.
  3. In the Quick Find box, enter and click “Permission Sets.”
  4. Create a new permission set.
    1. Click New.
    2. In the Label field, enter a descriptive name for the permission set, such as “Read Access to Product2.”
    3. Click Save.
  5. Configure object permissions.
    1. Click “Object Settings” or “Object Permissions” in the Apps section.
    2. Find and click the Product (Product2) object. If you don’t see it, use the search function to locate it.
    3. Click Edit next to the Products heading.
    4. In the Object Permissions section, set Read to “Enabled” (checked). Do not enable Edit, Create, and Delete unless they are needed.
    5. Click Save.

Step 2: Assign the newly created permission set to the public user.

  1. Navigate back to the site you created.
  2. Click Public Access Settings.
  3. Click the View Users or Assign Users button.
  4. Click the link for the site guest user.
  5. In the Permission Set Assignments section, click Edit Assignments.
  6. Move the newly created permission set from the Available Permission Sets column to the Enabled Permission Sets column.
  7. Click Save.
trigger customWebhookTrigger on Webhook_Event__c (before insert, after insert) {
    if (Trigger.isBefore) {
        for (bt_stripe__Webhook_Event__c webhook : Trigger.new) {
            if (webhook.bt_stripe__Type__c == 'invoice.created') {
                webhook.bt_stripe__Process_Async__c = true;
            }
        }
    }

    if (Trigger.isAfter) {
        List<Webhook_Event__c> webhooks = [SELECT Id, Name, Type__c, Process_Async__c, Processed__c, Payment_Gateway__c, Data__c FROM Webhook_Event__c WHERE Id IN :trigger.new];
        for (Webhook_Event__c webhook : webhooks) {
            if (webhook.bt_stripe__Process_Async__c && webhook.bt_stripe__Type__c == 'invoice.created') {
                // Call without sharing class here to process the webhook
            }
        }
    }
}

NOTE: Replace 'invoice.created' or add additional webhook types as needed.

Next Steps

Troubleshooting

If you have received an error in the Setup Wizard, with Webhooks or have a question, please view our Troubleshooting page.


What's Next