Set Up a Third-Party Connector in Salesforce Spiff

Create a Webhook in Spiff

A webhook provides an endpoint that Spiff uses to verify that the data source is legitimate and to request data from.

1. From the Admin menu, select Settings.
2. Scroll to the bottom of the left navigation panel and select Webhook Settings.
3. Click Add Webhook.
4. Make a note of the webhook ID and secret shown in the confirmation window.

Configure the Webhook Mapping

1. Go to the Synced Objects and Fields page.
   • If you’re still on the Webhook Settings page, click the three dots next to the webhook and select Manage Mappings.
   • From any other page in the app, go to the Admin menu, select Connectors, and then select Synced Objects & Fields.
2. Hover over Webhook in the left panel and click the + icon.
   
3. Complete the mapping form.
   
   • Mapping Type (1) specifies the normalized mapping that determines how some other options behave. For custom objects, select Synced Record. You can’t change this value after you save.
   • Mapping Label and Mapping Label Plural (2) specifies a name for the mapping.
   • Required Translator Fields (3) specifies a JSON representation of the required fields. When you send data with a webhook, you send a JSON body with a list of structure objects. Every object type requires a unique external_id, and some normalized objects require other fields.
   • Allowed Translator Fields (4) specifies the object’s other supported fields.

   For example, if Mapping Type is User, each user has the fields name, email, and external_id. Include the field role or role_uuid depending on whether users have default Spiff roles or custom roles.

   • If your users have default Spiff roles assigned, include the role field.
   • If a Spiff admin created custom roles and your users have custom roles assigned, include the role_uuid field instead. Make sure that your data source specifies the custom role’s UUID. To find the UUID of a custom role, select the role on the Role Management page and copy the UUID from the page URL, such as e9591490-cd7f-4309-84c7-061fdb6894e6.
4. Save your changes.

Note You can’t update translator fields after you’ve started syncing data with a webhook mapping.

Add Connector Fields

Because the data format for the connector is uncertain, create a connector field for each translator field that you specified in the mapping. For example, external_id is a required translator field and connector field for all objects.

1. On the Synced Objects and Fields page, hover over the name of the mapping or object under the webhook, click the edit icon, and select Manage Mapping.
   
2. Click the Connector Fields tab.
3. Click Add New Connector Field and add these values.
   • For Name and Label, enter identical values.
   • For Data Format, specify the data type for the field so that Spiff can parse and import the data correctly.
4. Save your changes.
5. Repeat these steps for other connector fields.

View or edit mappings and connector fields that you specified for a webhook on the Synced Objects and Fields page.

Important You can delete webhook mappings individually, but you can’t undo a deletion. You can’t delete a webhook.

If you’re implementing a Workato integration, continue with the remaining steps.

If you’re implementing a custom integration with Spiff webhook endpoints, stop here and see Get Started with Salesforce Spiff Webhook API in the Salesforce Spiff Developer Guide for next steps.

Set Up Connections and Recipes in Workato

If you purchased the Spiff connector in Workato, other fields are available on the Webhook Settings page in Spiff. An embedded Workato window is also available.

Important Complete these steps as a user with access to Workato, and make sure that you completed all the previous steps first.

1. In Spiff, from the Admin menu, select Connectors and click Data Automation.
2. In the embedded Workato window, add the Spiff connection.
   1. Go to Projects | Connections.
   2. Search for Spiff and add the Spiff connection.
   3. Enter the webhook ID and secret that you saved when you created the webhook in Spiff.
   4. Update the subdomain, depending on your region.
      • If you’re in the US, use us1.
      • If you’re in the EU, use eu1.
3. Add another connection for the Inbound Data Source, such as BambooHR or Netsuite.
4. Configure Workato recipes.
   1. Go to Connectors From the Admin menu, click Data Automation, and then click Recipes.
   2. Set up Workato recipes and connections to map your data to the correct fields in Spiff.
      A recipe defines the components and rules for processing your data. For more information about working with Workato recipes, complete the Automation Pro I, Automation Pro II, and Automation Pro III certificate courses in Workato Academy. See Automation Pro Certificate Courses in Workato Academy.
5. Specify an email address for receiving connection or recipe error notifications.
   1. From the Admin menu, select Settings, and click Webhook Settings.
   2. Enter an email address and select a time zone.
   3. Save your changes.

Configure Salesforce Spiff to Sync with the Data Source

To make sure that the Global Sync option in Spiff also syncs Workato data, create a webhook-triggered recipe in Workato for importing your data. After you configure the webhook, Spiff sends a request to Workato that triggers your recipe.

1. In Workato, create a webhook-triggered recipe. See Create a webhook with the wizard in Workato Docs.
2. In Spiff, from the Admin menu, select Settings, and click Webhook Settings.
3. Hover over the webhook, click the three dots, and select Edit Webhook.
4. Enter the URL that Workato provided for the webhook-triggered recipe.
5. Save your changes.
6. Click the sync data icon in the top right corner of Spiff. Verify that the source system sends data to Workato and make sure that the data loads correctly in Spiff. Check all objects and resolve any errors in Workato.
7. Complete user acceptance testing.