Contact Us 1-800-596-4880

Spiff Connector 1.0

Anypoint Connector for Spiff (Spiff Connector) connects Mule applications to the Salesforce Spiff Webhook API. Use it to send CRM, HR, billing, or other source-system records into Spiff for commission calculations, and to remove them again.

Spiff receives external data through a webhook connector. Each connector has one or more mappings, and each mapping defines translator fields: the shape of the records that Spiff accepts.

Use Spiff Connector to:

  • Upsert and delete records through a mapping, one record at a time or in bulk.

  • Verify the webhook signature against Spiff with Test Webhook, without upserting data.

  • Build typed input metadata from the translator fields, so DataSense shows the record shape in Anypoint Studio and Anypoint Code Builder.

  • Sign every request with HMAC-SHA256 using the webhook secret. The secret itself is never sent or logged.

Spiff Connector operations are non-blocking: the connector sends each signed request asynchronously and frees the flow’s thread while it waits for Spiff to respond.

Before You Begin

To use this connector, you must be familiar with:

  • The Spiff Webhook API and Spiff Admin

  • Anypoint Connectors

  • Mule runtime engine (Mule)

  • Elements and global elements in a Mule flow

  • How to create a Mule app using Anypoint Studio or Anypoint Code Builder

Before creating an app, you must have:

  • Access to a Spiff tenant with permission to manage webhook connectors in Spiff Admin

  • A Spiff webhook connector with at least one mapping

  • The latest version of Anypoint Studio or Anypoint Code Builder

  • A Mule Enterprise license (evaluation licenses are accepted)

Common Use Cases for the Connector

  • Sync deals for commission calculation

    Push closed-won opportunities from Salesforce or another CRM into a Spiff mapping whenever they change.

  • Bulk backfill

    Load historical records into a new mapping in batches, each request body at most 5 MiB (5,242,880 bytes).

  • Keep Spiff clean

    Delete records from Spiff when the source record is deleted or no longer qualifies.

  • Monitor the integration

    Run Test Webhook on a schedule to confirm that the webhook secret is still valid after a rotation.

Typical Integration

In production, a source system triggers the flow, not an HTTP call. A typical app:

  1. Receives a change from the system of record, for example a connector source, change data capture, Anypoint MQ, or a scheduled query.

  2. Maps the source fields onto the Spiff mapping’s translator fields in Transform Message, with the source record’s ID as the identity field (usually external_id). Pick the mapping from the Mapping ID dropdown so that DataSense shows those fields.

  3. Call Put Single Record for one change, or Put Multiple Records for batches and backfills.

  4. Call Delete Single Record or Delete Multiple Records with only the identity field when the source record is deleted or no longer qualifies.

  5. Wraps the operation in until-successful to retry SPIFF:RATE_LIMITED, SPIFF:SERVER_ERROR, and SPIFF:TIMEOUT.

Spiff validates record bodies asynchronously, so a successful response means that Spiff accepted the request, not that the record was written.

The connector fetches the webhook connector’s mappings and each mapping’s translator fields internally, at design time, to populate the Mapping ID dropdown and the record and identity input types. These lookups aren’t exposed as operations.

Connection Types

Spiff Connector has one connection type, HMAC Signed Webhook Connection (<spiff:hmac-connection>). Spiff authenticates each request with an HMAC-SHA256 signature of the request body, keyed with the webhook secret. There is no token or session to manage, and the secret itself is never sent or logged. For the connection fields, see HMAC Signed Webhook Connection.

Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector using Anypoint Studio or Anypoint Code Builder. To configure the connector in XML instead, see Spiff Connector XML and Maven Support. For examples of how to use the connector, see Spiff Connector Examples.