Custom connector
Use custom connectors to integrate private APIs, wallet lifecycle hooks, and script-based email delivery when no native connector fits.
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.
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.
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.
Generic 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.
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 built-in connector when one already exists for the target platform.
Use a custom connector when logic must call a private API or internal relay.
Use a custom connector when runtime behavior must react to pass lifecycle events.
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.
Last updated