When a publish extension uploads a user's design to the destination platform, the /publish/resources/upload endpoint can provide a url:
{"type": "SUCCESS","url": "https://example.com"}
This URL is shown in the dialog that appears after the design is published.
For an app to be approved for release via the Apps Directory(opens in a new tab or window), it must provide a URL that satisfies the UX guidelines.
Generate external link
You can configure a publish extension to display the URL of the published design with the anchor text "View in [App name]" instead of the complete URL.
To do this:
- Navigate to an app via the Developer Portal.
- From the Extensions page, expand the Publish pane.
- Enable Generate external link.
UX guidelines
At a minimum, the URL must allow the user to view their published design in the context of the destination platform. For example, if a user publishes a design to Twitter, they should see a link to their tweet.
If the destination platform expects further action, the URL should take the user to where they can complete that action. For example, a website creation tool may provide the URL of a page that allows the user to choose where to place their published design.
The URL must be fewer than 2000 characters.