Integration link generator

Generating a link

1. Open the profile menu at the bottom of the sidebar and choose Tools.
2. Select the Integration link generator tab.
3. Pick the integration. The list only contains integrations of type "URL that reads parameters". If you have none, the empty state links you to the Integrations page. You also reach the tool from the detail view of an integration via Open in link generator. The tool warns you if the integration has a forwarding URL active. In that case the generated link does not create passes.
4. Choose which parameters to include and fill in their values.
   • Template properties are the additional properties of the template, with badges for "required" and "unique" fields and the available Options: of select fields. Notes explain special cases, for example that the integration link cannot fill checkbox properties.
   • System parameters are barcodeValue, userProvidedId, expirationDate and urlToThumbnail, urlToLogo and urlToBackground. The tool describes the expiration format as Format: YYYY-MM-DD HH:MM (24-hour clock). It offers each parameter only when the template uses the corresponding feature, such as "barcode value differs per pass".
   • Language of the pass page is a prefix selector that controls the language of the download page.
   • Tracking parameters such as utm_source travel through to the download page. See utm tracking parameters.

Checking the link

The tool shows the Generated link with an optional QR code. Before you share it, use Check link for a dry run. The tool reports whether the link creates a pass, shows an existing pass instead because of deduplication, forwards to another URL or creates no pass at all. It also lists errors, warnings and notes. Examples are an exceeded plan limit, the maximum number of passes of the template reached, an invalid expiration format or an unmatched parameter. Other examples are a missing required property, a wrong domain or an unknown language prefix.

The tool also has a validator named Check an existing link for links you built elsewhere. Paste any integration link to run the same checks.

For developers

If you generate links programmatically, follow the matching rules that the tool documents. Passcreator matches parameters against the property names of the template. The match is case sensitive, and spaces and dots in property names become underscores. The reserved parameter names barcodeValue, userProvidedId, expirationDate, urlToThumbnail, urlToLogo and urlToBackground are always available when the template uses the corresponding feature. URL encode all values.