> 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/developers-guides/scripting/endpoints.md).

# Runtime endpoints

Every runtime endpoint a script can register, with its key, what it changes, what it needs in the configuration and where it is documented.

A runtime endpoint is a named extension point of The Wallet Crew platform itself: the place where a tenant script takes over one precise decision, such as the data a pass displays, the pass type chosen at creation or the URL a holder is redirected to. Connector-specific extension points (`extensions.*`) are listed separately in [Connector scripts](https://docs.thewalletcrew.io/developers-guides/scripting/extensions.md).

A script declares an endpoint by calling `context.register(key, handlers)` in the default export of a file under `server/scripts/`; how files are loaded, and why a key should be registered in one file only, is explained in [How scripts run](https://docs.thewalletcrew.io/developers-guides/scripting/how-scripts-run.md). Handler names, casing and return conversion are common to every endpoint and are described in [Handlers](https://docs.thewalletcrew.io/developers-guides/scripting/handlers.md).

## Endpoints at a glance

Keys are case-sensitive, including the doubled word in `scriptableAccountValidator` (the spelling is part of the key). A `{scriptId}` or `{templateId}` suffix is chosen by the brand and must match, character for character, the identifier written in the configuration that runs the script.

| Key                                                            | Purpose                                                                                                                                                     | Wiring                                                                                                                                                  | Page                                                                                                                                              |
| -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `runtime.scriptable.passDataProvider.{scriptId}`               | Fills the data a pass displays from an external system, and describes that data to the admin console.                                                       | `dataProviders` entry `provider: script` in `server/passes/<passType>.yml`; optionally `customerProviders` entry `type: script` in `server/account.yml` | [Pass data provider](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/pass-data-provider.md)                                   |
| `runtime.scriptable.customerProvider.{scriptId}`               | Obsolete name of the pass data provider. Still runs where no pass data provider is registered under the same script id.                                     | Same as the pass data provider                                                                                                                          | [Obsolete customerProvider script key](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/customer-provider-obsolete.md)         |
| `runtime.scriptable.customerPipelineElement.{scriptId}`        | Runs custom code as one step of a customer registration flow, for example to create the customer in a CRM.                                                  | Step `type: script` in a flow of `server/flows.yml`                                                                                                     | [Customer pipeline element](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/customer-pipeline-element.md)                     |
| `runtime.wallet.passUpdater`                                   | Chooses the pass type or rewrites identifiers when a pass is created or updated, and is notified when a pass is created, updated, installed or uninstalled. | None: registering is enough                                                                                                                             | [Pass updater](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/pass-updater.md)                                               |
| `runtime.scriptable.pushUpdates.{scriptId}`                    | Builds, from a scheduled task, the list of passes to update and what to change on each.                                                                     | Task `type: wallet.scriptablePushUpdates` with `settings.scriptName` in `server/scheduler.yml`                                                          | [Push updates](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/push-updates.md)                                               |
| `runtime.scriptable.emailEngine`                               | Sends the platform's emails through the brand's own email or marketing automation service.                                                                  | `provider: { type: script }` in `server/emails.yml`                                                                                                     | [Email engine](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/email-engine.md)                                               |
| `runtime.scriptable.scriptableAccountValidator`                | Rejects an enrolment with field-level error messages before anything is created.                                                                            | None: registering is enough                                                                                                                             | [Account validator](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/account-validator.md)                                     |
| `runtime.emailAccountChallenger.templateFinder`                | Picks the email template of the identity-confirmation email, or skips the email.                                                                            | An `email` account challenger in `server/account.yml`                                                                                                   | [Email challenge template](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/email-challenge-template.md)                       |
| `runtime.wallet.linkUrlEnricher`                               | Rewrites the destination URL of a tracked link tapped in a pass, for example to add campaign parameters.                                                    | None: registering is enough (it replaces the default UTM parameters)                                                                                    | [Link URL enrichment](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/link-url-enrichment.md)                                 |
| `runtime.import.updatePasses.rowTransformer`                   | Reads the rows of a bulk "update passes" CSV file whose columns do not follow the documented format, and sets the pace of the file.                         | None: registering is enough                                                                                                                             | [Bulk pass update row transformation](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/bulk-pass-update-row-transformation.md) |
| `runtime.benefit.benefitProvider`                              | Keeps the benefits of a pass in step with an external system that can only be read.                                                                         | None: registering is enough                                                                                                                             | [Benefit provider](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/benefit-provider.md)                                       |
| `runtime.wallet.applePassResolver`                             | Recovers an Apple Wallet pass that a device knows but The Wallet Crew does not, typically after a migration from another platform.                          | None: registering is enough (one registration per tenant)                                                                                               | [Apple pass resolver](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/apple-pass-resolver.md)                                 |
| `runtime.scriptable.benefitTemplateCodeGenerator.{templateId}` | Computes the code of each benefit issued from a benefit template whose code mode is custom.                                                                 | Written by the platform from the benefit template's code settings                                                                                       | [Benefit code generator](https://docs.thewalletcrew.io/developers-guides/scripting/endpoints/benefit-code-generator.md)                           |

## How the endpoints differ

Endpoints differ in what happens with a missing handler, several registrations of one key, no registration at all, and an error. [Handlers](https://docs.thewalletcrew.io/developers-guides/scripting/handlers.md#comparison-of-the-endpoints) holds the one table of these facts; each endpoint page gives the detail and says when the endpoint runs.


---

# 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/developers-guides/scripting/endpoints.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.
