New Install Callback Fields

Announcements
, ,
#1

Hi, I just wanted to highlight a blog post which is relevant to app vendors.

We will be adding some new fields to the install payload to inform apps if an instance is associated with a custom domain name. Unless your app is strictly validating the content of the install payload the addition of these fields should not cause any problems.

For the most part we do not expect apps to need the information in these fields. It is provided for any cases where an app needs to render links, server side, using the custom domain.

Initially these fields will contain the same value as the baseURL field. There will be followup notices when we start to populate these fields with distinct values. In the interim the fields may or may not be present for a given instance as we rollout this support. Apps should not require these fields to be present.

Please let me know if you have questions or concerns

6 Likes
#2

Has this been tested with ACE?

#3

@boris The new fields will not cause an ACE based app any issues. While the new fields will not cause any issues, I do note that the current version of ACE will not take any action to store or use these fields.

#4

Hello @cmacneill,

One of our plugin is based on Atlassian-connect-spring-boot. We are using AtlassianHostUser -> baseUrl property to extract the URL prefix of the Atlassian product instance. We use this base Url for generating some links. Will this property reflect the updated value after the custom domain / site rename changes?

Also ACE - injects context variables into the rendering context which includes hostBaseUrl . Can you please confirm that the hostBaseUrl will contain the correct value after the custom domain / site rename changes?

Thanks!!

1 Like
#5

@sfg The baseUrl field will continue to refer to the xxx.atlassian.net site URL and will not reflect any custom domains applied to a site. This is the URL you should use for any REST API calls. The same will apply to the ACE framework.

For rendering links, serverside, you should use the new displayUrl field when it becomes available. We’ve delayed the rollout of the new fields as discussed in ETA for custom domain lifecycle payload changes

#6

@cmacneill , Thanks for the update.

Wanted to make sure I understand it correctly : When the site rename happens or a custom domain is added to the site, the installed webhook event will be called behind the scenes which will update the record in the atlassian_host table with the new payload (which will contain the ‘displayUrl’ ).

No changes are required on the plugin side unless we need to generate custom links on the server side. In that case we need to consume the displayUrl (when available) which may or may not be same as the baseUrl.

#7

@sfg Yes, your understanding is correct.

#8

How about domain whitelist in atlas connect express? https://ecosystem.atlassian.net/browse/ACEJS-154

// Make sure that your add-on can only be registered by the hosts on
// these domains.
  "whitelist": [
      "*.jira-dev.com",
      "*.atlassian.net",
      "*.jira.com"
    ]
1 Like