> 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/custom-connector-scripting-reference/wallet-link-url-enrichment.md).

# Wallet link URL enrichment

Rewrite a wallet link redirect URL before a customer is redirected, using \`runtime.wallet.linkUrlEnricher\`.

This optional hook runs when a wallet link redirect (a short `wlt.pm/~...` link) is resolved, before the customer is redirected to the destination URL. It can rewrite the URL — for example, to add tenant-specific tracking parameters. It needs no additional configuration — registering the endpoint in a script is enough for it to be called.

```js
/**
 * @typedef {Object} PassContext
 * @property {string} PassId
 * @property {string} PassType
 * @property {Record<string, string>} Identifiers
 * @property {Record<string, any>} [AdditionalData]
 * @property {Record<string, any>} Metadata
 * @property {"apple"|"google"} [Device]
 * @property {string} [Origin]
 * @property {string} [SourceId]
 * @property {string} [Language]
 */

/**
 * @param {string} url - The destination URL about to be used for the redirect.
 * @param {PassContext} context - Information about the pass and the link's source.
 * @returns {Promise<string|null>} The URL to redirect to, or null to keep the original URL unchanged.
 */
async function enrich(url, context) {
  return url + (url.includes("?") ? "&" : "?") + "passType=" + encodeURIComponent(context.PassType);
}

export default function (context) {
  context.register('runtime.wallet.linkUrlEnricher', {
    Enrich: enrich
  });
}
```

{% hint style="info" %}
When this endpoint is not registered, The Wallet Crew applies its own default UTM parameters (`utm_source=thewalletcrew`, plus `utm_medium`/`utm_campaign`/`utm_content` derived from the link's source) instead. Registering this hook replaces that default behavior entirely for every wallet link.
{% endhint %}


---

# 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/custom-connector-scripting-reference/wallet-link-url-enrichment.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.