Skip to main content

Zuper to iPaaS.com Customer Mapping Documentation

How the Zuper to iPaaS.com Customer mapping collection captures customer and address records from Zuper into iPaaS.com, including field mappings, triggers, and validation.

Summary

This article describes how the integration captures customer records from Zuper into iPaaS.com. When a customer is created or updated in Zuper, the integration reads the full customer record and creates or updates the matching customer in iPaaS.com, along with the customer's address through a child collection. This keeps the iPaaS.com customer list synchronized with Zuper so downstream systems connected to iPaaS.com work from current customer data.

ID Format

Manual Sync ID Format

The Manual Sync identifier is the Zuper customer identifier (customer_uid). Enter this value on the iPaaS.com Manual Sync page to capture a specific customer.

Example: 800af730-b7fb-11ed-80d7-bb59aacf01c7

External ID Format

After a successful transfer, iPaaS.com records the Zuper customer_uid as the external ID on a dedicated external-ID record, which routes later updates to the same iPaaS.com customer. The CustomerNumber mapping also carries this identifier onto the iPaaS.com customer record, which provides visibility and serves as a fallback match when no external-ID record yet exists.

Deleted Record Support

This collection captures customer creates and updates. It does not remove customers from iPaaS.com. Hard deletion in Zuper is out of scope for this collection.

Mapping Collection Status

Enabled.

Trigger Events: The TO iPaaS.com direction supports Zuper webhooks enabled under Inbound Data Flows — most commonly customer.create and customer.update — plus Manual Sync. No automatic transfers occur until the customer webhook events are enabled.

Duplicate or Conflicting Mappings

The Add Zuper Customer FROM iPaaS.com collection operates on the same customer entity in the opposite direction, sending customers from iPaaS.com to Zuper. Before enabling both directions, review the filters and Add/Update settings on both collections and decide which system is the source of truth for customer data, to avoid records overwriting each other.

Collision Handling

This collection does not use collision handling. Records are matched by the saved external ID and, before an external-ID link exists, by the customer identifier (customer number) — not by a configurable collision rule.

Supported Child Collections

Add Zuper Customer Address TO iPaaS.com captures the customer's address from Zuper as part of this customer transfer. The address is linked to the customer it belongs to and is not captured independently.

Zuper Caveats

Webhook events must be enabled to capture changes automatically: until the Zuper customer events are enabled under Inbound Data Flows, customer changes are captured only through Manual Sync.

Addresses are captured with the customer: address values arrive as part of the parent customer transfer, not as a separate call.

iPaaS.com Caveats

The captured record is created in iPaaS.com as an individual customer by default. The Zuper Organization flag is recorded on the customer so the record type can be reflected if the customer is later sent back to Zuper.

The captured address is attached to the parent iPaaS.com customer created or updated by the parent collection.

Setup Requirements

Enable the Zuper customer webhook events (for example, customer.create and customer.update) under Inbound Data Flows in the subscription configuration so that customer changes in Zuper flow into iPaaS.com automatically.

Authentication uses a Zuper API key. For the steps to obtain the API key and configure the subscription, see the Zuper Installation Instructions article.

Integration Flow

A single transfer brings the record into iPaaS.com:

  1. The integration retrieves the full customer from Zuper by its identifier (GET on the Zuper Customer endpoint).

  2. The customer fields are mapped and the record is created or updated in iPaaS.com, together with its address.

Add Zuper Customer TO iPaaS.com

This collection maps the Zuper customer record onto the iPaaS.com customer.

Mapping Type

Source Field (Zuper)

Destination Field (iPaaS.com)

Description

Static

"false"

Zuper Organization

Records, on a custom field, whether the captured record represents a Zuper organization. It is set to a fixed value of false, so every customer captured from Zuper is marked as an individual by default. Optional.

Field

Id

CustomerNumber

Stores the Zuper customer identifier as the iPaaS.com CustomerNumber. It is the value subscribers enter on the Manual Sync page and lets iPaaS.com match an existing customer on later transfers. Required.

Field

FirstName

FirstName

Captures the customer's first name from Zuper. Recommended for a complete customer record.

Field

LastName

LastName

Captures the customer's last name from Zuper. Recommended.

Field

Email

EmailAddress

Captures the customer's email address from Zuper. Recommended for contact completeness.

Field

Company

Company

Captures the company name from Zuper. Optional; map it when you want the company name available on the iPaaS.com customer record.

Field

Description

Comment

Captures the Zuper customer description into the iPaaS.com customer comment. Optional.

Add Zuper Customer Address TO iPaaS.com

This child collection maps the Zuper address fields onto the iPaaS.com customer's address as part of the parent customer transfer.

Mapping Type

Source Field (Zuper)

Destination Field (iPaaS.com)

Description

Dynamic Formula

if (IsPrimary == true) {return "true";} else {return null;}

Zuper Primary Contact

Records, on a custom field, whether the captured address is the customer's primary address in Zuper. Set to true when the Zuper address is primary; otherwise no value is set. Optional.

Field

FirstName

FirstName

Captures the contact first name stored on the Zuper address. Optional.

Field

LastName

LastName

Captures the contact last name stored on the Zuper address. Optional.

Field

Street

Address1

Captures the Zuper street line into the iPaaS.com address line. Recommended.

Field

City

City

Captures the city from the Zuper address. Recommended.

Field

State

Region

Captures the Zuper state into the iPaaS.com Region field. Recommended.

Field

Country

Country

Captures the country from the Zuper address. Recommended.

Field

ZipCode

PostalCode

Captures the postal or zip code from the Zuper address. Recommended.

Dynamic Formula

if (IsPrimary == true) {return false;} else {return null;}

IsPrimaryBilling

Marks whether the captured address is treated as the billing address on the iPaaS.com side. When the Zuper address is primary, this is set to false so it is treated as the service address rather than billing; otherwise no value is set. Optional.

Field

PhoneNumber

PhoneNumber

Captures the contact phone number stored on the Zuper address. Optional.

Error Handling

For the errors this integration can return and how to resolve them, see the Zuper Error Messages article.

Testing & Validation

Test Scenarios

  • Create a new customer in Zuper with a first name, last name, email, and address, then confirm a matching customer with its address appears in iPaaS.com.

  • Update an existing Zuper customer's details and confirm the change flows to the same iPaaS.com customer rather than creating a duplicate.

  • Run a Manual Sync using the Zuper customer_uid and confirm the customer is captured.

  • Create a Zuper customer that has a primary address and confirm the primary designation is preserved on the iPaaS.com record.

Validation Checklist

  • The Zuper customer webhook events are enabled under Inbound Data Flows.

  • The iPaaS.com customer's CustomerNumber matches the Zuper customer_uid.

  • FirstName, LastName, and EmailAddress are populated when present in Zuper.

  • The address fields (Address1, City, Region, PostalCode, Country) are captured on the iPaaS.com customer's address.

  • Updating a Zuper customer updates the existing iPaaS.com customer instead of creating a new one.

Additional Notes

Out of Scope

This collection captures customer creates and updates only; it does not remove customers. There is no bulk initialization — records transfer individually through webhook events or Manual Sync at the time this documentation was written. A Zuper address cannot be captured on its own; it always travels with its customer.

Related Documents

Did this answer your question?