Custom connector

Use custom connectors with tenant scripting to integrate private APIs, wallet lifecycle hooks, and custom email delivery.

Custom connectors let The Wallet Crew integrate with systems that do not have a native connector. They are useful when a brand or partner needs to fetch external data, react to wallet lifecycle events, or route transactional emails through an internal delivery stack.

Custom connectors for tenant-specific integrations

A custom connector is not a separate product module. It is a project-specific integration layer implemented with runtime hooks exposed by The Wallet Crew.

In practice:

1. The source system keeps ownership of business data.

2. The connector script resolves and maps the data needed by wallet passes.

3. The Wallet Crew generates and updates Apple Wallet and Google Wallet payloads.

This keeps the wallet layer aligned with existing systems without forcing a full native connector.

What is needed to design a new connector

Before implementation, define these inputs:

Required input	Why it matters
Source system and owner	Clarifies which team controls business rules and data quality
Stable identifiers (customerId, membershipId, ticketId, etc.)	Links wallet passes to source records over time
Trigger model (pull, push, lifecycle hooks)	Defines when data is fetched and when updates are propagated
API/event contract	Defines authentication, payload shape, and error handling
Operational ownership	Clarifies who monitors integration failures and retries

If these inputs are unclear, align them first before writing scripts.

Real-world examples

• A brand enriches a loyalty pass with points, tier, or profile data from a CRM.

• A team synchronizes pass installation status with a marketing, analytics, or BI platform.

• A partner keeps The Wallet Crew email rendering, but sends through its own gateway.

What this section covers

This section groups the custom connector patterns that are used most often in delivery projects.

Pass lifecycle hooks

Use this pattern when an external system must react to wallet installation changes.

Typical use cases include CRM synchronization, install-based segmentation, onboarding journeys, and uninstall tracking.

• Pass installation and uninstallation hooks

Script-based email delivery

Use this pattern when The Wallet Crew should still build the email content, but the final send must be handled by a provider or relay controlled outside The Wallet Crew.

This is useful for internal gateways, unsupported ESPs, or environments with strict delivery governance.

• EmailSender extensibility

Runtime scripting

Some custom connectors also need broader runtime scripts to enrich pass data or register custom provider logic.

This section focuses on the connector entry points used most often in Connect projects. For runtime registration and implementation details, see Developer custom connectors guide.

For a single index of every global, module, and registrable endpoint the runtime exposes — including narrower hooks not covered by the pages above — see:

• Custom connector scripting reference

When to use a custom connector

Use a custom connector when the integration needs are specific enough that a built-in connector would not fit cleanly.

Use a standard connector when one already exists. A standard connector can also be scoped by The Wallet Crew and the platform partner when it can support multiple brands.

Use a custom connector when tenant scripting must call a private API, use an internal relay, or react to pass lifecycle events.

Responsibilities split

Topic	Customer / partner	The Wallet Crew
External system access	Provides APIs, credentials, and business ownership	Provides runtime execution context
Data mapping rules	Defines semantic mapping from source fields	Applies mapped data to wallet payload generation
Lifecycle reactions	Decides what to do on install/uninstall	Emits lifecycle hooks and events
Email delivery (script provider)	Sends emails through selected relay/provider	Builds templates and calls script runtime

FAQ

When should a built-in connector be used instead?

Use a built-in connector when The Wallet Crew already supports the target platform and the expected workflow matches the project needs. Use a custom connector when the integration depends on private APIs, internal relays, or runtime-specific logic.

Is this the right place for install and uninstall synchronization?

Yes. For wallet installation lifecycle events, start with Pass installation and uninstallation hooks.

Is this the right place for a custom email gateway?

Yes. For script-based transactional email sending, use EmailSender extensibility.

Where is the generic custom connector scripting model documented?

This page focuses on the connector entry points exposed in the Connect section. The full walkthrough is in the Developer custom connectors guide, and every registrable endpoint — including ones with no dedicated page — is indexed in the Custom connector scripting reference.

Can an unlisted platform become a standard connector?

Yes. The Wallet Crew and the platform partner can jointly scope a built-in connector when it can support multiple brands. For tenant-specific integrations, use a custom connector with tenant scripting and APIs.