Webhooks

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.

Assign the Blackthorn | Payments (Site Guest User) 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. Add the Blackthorn | Payments (Site Guest User) permission set to this user's record.
6. Click Save.
   

Configure Webhooks and Add Webhook Events

• In Stripe
• In Authorize.net

Configure Webhook in Stripe

1. Select "Developers" on the top left-hand side of the page.
2. Select "Test Mode" (next to the Developers' tab).
3. Select the "Webhooks" tab on the left-hand side.
4. Click Add endpoint.
5. In the Endpoint URL field, set the URL to the Salesforce webhook Site you just created. Replace the three 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 setup.
   • 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.
6. Check that the latest version is selected.
7. Under "Select events to listen to," click Select Events and choose "Select All Events."
8. Click the blue Add Events.
9. Click Add endpoint.

Configure Webhook in Auth.net

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

2. Click on Account tab | Settings | Webhooks.
   

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.
   

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.
   
4. Set Event type = "customer.created".
5. Click Send test webhook.
   

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.

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.

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.
   

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

5. Click Webhook Secret | Manage Records

6. Click New.

7. Enter values for Label, Webhook Secret Name, and Signing Secret.

8. Click Save.
   

Process Stripe Billing Webhook Types Asynchronously

trigger ProcessWebhooksAsync on bt_stripe__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 == 'customer.created') {
        webhook.bt_stripe__Process_Async__c = true;
      }
    }
  }
  
  if (Trigger.isAfter) {
    for (bt_stripe__Webhook_Event__c webhook : Trigger.new) {
      if (webhook.bt_stripe__Process_Async__c && webhook.bt_stripe__Type__c == 'customer.created') {
        bt_stripe.ProcessEventStripeAsync(webhook);
      }
    }
  }
  
}

Next Steps

• Insert the Virtual Terminal onto your parent object(s) Page Layouts.
• Use Payment Schedules to create future looking Transactions in minutes.
• Learn about our supported Payment Methods.

Troubleshooting

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