> For the complete documentation index, see [llms.txt](https://docs.thewalletcrew.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thewalletcrew.io/connectors/custom-connector.md).

# Custom connector

A custom connector integrates a system with no native connector through tenant scripting: a short guide for non-developers, with developer links.

A custom connector lets The Wallet Crew integrate with a system that has no native connector. A developer writes it as tenant scripts that run on the platform. It is not a separate product module.

It is needed when the integration must call a private API, fetch external data for a pass, react to wallet lifecycle events, or route transactional emails through an internal gateway. When a native connector already exists, use it. See [Wallet pass connectors](https://docs.thewalletcrew.io/connectors/wallet-pass-connectors.md) to choose a path.

<details>

<summary><strong>Real-world examples</strong></summary>

* 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.

</details>

## What is needed to design a new connector

Before implementation, the team settles five inputs: the source system and its owner, the stable identifiers, the trigger model, the API or event contract, and who operates the integration. The [Build checklist](https://docs.thewalletcrew.io/developers-guides/scripting.md#build-checklist) in the Developers guides lists what each input must produce. If these inputs are unclear, align them first before writing scripts.

## Where the developer documentation is

The [Developer custom connectors guide](https://docs.thewalletcrew.io/developers-guides/scripting.md) explains how to build a custom connector. The scripting model and every runtime endpoint are in the Scripting section of the Developers guides.

Two entry points have a page in this section:

* [Pass installation and uninstallation hooks](https://docs.thewalletcrew.io/connectors/custom-connector/installation-changed-extensibility.md): react to wallet installation changes, for example to synchronize a CRM.
* [EmailSender extensibility](https://docs.thewalletcrew.io/connectors/custom-connector/emailsender-extensibility.md): send transactional emails through a provider or relay outside The Wallet Crew.

The responsibilities of each side are in [Wallet pass connectors](https://docs.thewalletcrew.io/connectors/wallet-pass-connectors.md#responsibilities).

## FAQ

<details>

<summary><strong>Can an unlisted platform become a standard connector?</strong></summary>

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.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.thewalletcrew.io/connectors/custom-connector.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
