What are Webhooks

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 captured, 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.

Step One: Create a Force.com Domain

  • Within Setup In the Quick Find, type in and click "Sites."
  • If a Force.com domain has not been setup continue with the instructions, otherwise navigate to Step Two.
  • Enter a value for your Force.com domain and click check availability
  • Accept Site terms of use and click "Register My Force.com Domain."

Step Two: Site Configuration

  • Click New next to Sites.
  • Set a Site Label, Site Name, and Default Web Address (We suggest using webhook or stripe).
  • Check the Active checkbox.
  • On 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).
  • Check Require Secure Connections (HTTPS).
  • Click Save.

Step Three: Assign the Blackthorn | Payments (Webhook Event Admin) Permission Set:

  • Click on Public Access Settings
  • Click on "View Users" or "Assign Users"

  • Click on the user

  • Add the Blackthorn | Payments (Webhook Event Admin) permission set to this user's record

Not seeing a Blackthorn | Payments (Webhook Event Admin) permission set? Please upgrade to the latest version then try again.

  • Click Save.

Step Four: Configuring Webhooks

Configure Webhook in Stripe

  • 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.
  • Select the Developers tab on the left hand side.
  • Click the Webhooks tab and select Add endpoint.
  • In the URL to be called field you need to 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 setup. To get this value, navigate to the Site record and look at the Custom URLs related list. If you see more than 1 domain name, always use the one with secure in the name - these use https which is required by Stripe. Use the Domain Name value.

SITE_PATH = The Path for the Site. Use the Path value from the Custom URLs related list of the Site.

WEBHOOK_LABEL = To get this value, navigate to the Payment Gateway record you want to use. Then copy the value from the Webhook Label field.

So for the images above, your webhook url would be:
https://adminmethods.secure.force.com/stripe/services/apexrest/bt_stripe/webhook/test

Note
If you have multiple Stripe Accounts connected to your Salesforce Org, and want to create Webhook Endpoint for each in Stripe, 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.

Configure Webhook in Auth.net

  • Navigate to your connected Auth.net account dashboard.
  • Go to the 'Account' Tab, then 'Settings' and select 'Webhooks'
  • Click Add endpoint.
  • Define a 'Name'
  • In the Endpoint URL field you need to 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 setup. To get this value, navigate to the Site record and look at the Custom URLs related list. If you see more than 1 domain name, always use the one with secure in the name - these use https which is required by Stripe. Use the Domain Name value.

SITE_PATH = The Path for the Site. Use the Path value from the Custom URLs related list of the Site.

WEBHOOK_LABEL = To get this value, navigate to the Payment Gateway record you want to use. Then copy the value from the Webhook Label field.

Note
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.

Step Five: Add Webhook Events

Step Six: Verify Webhook Connection in Stripe

Verifying in Test Mode:

  • Select the API tab on the left-hand side and click the Webhooks tab.
  • Click on your URL.
  • In the top right, click "Send Test Webhook."
  • Event Type: "Customer.Created" and click "Send Test Webhook."
    If you received a "Test webhook sent successfully" message, 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.

  • Create a new Customer in Stripe.
  • Click on the newly created customer record, scroll down to Events, and select the Event record.
  • Scroll down to Webhooks.
    If the Webhook record says "Success", then Webhooks are set up correctly in Production.

Step Six: Adding Webhook signatures (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'
  1. Navigate in your Salesforce Org to Setup | Custom Metadata Settings
  2. Click Webhook Secret | Manage Records
  3. Click New
  4. Enter values for 'Label', 'Webhook Secret Name' and 'Signing Secret'
  5. Click Save

Next Steps:


Troubleshooting/FAQ

If you have received an error in the Setup Wizard, Webhooks or have a question, please view our Troubleshooting and Frequently Asked Questions. If you still have Setup Wizard or Webhook questions, please contact Blackthorn Support. We're happy to help!

Webhooks


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.