Forge Site Id Documentation

Forge Adopting Forge from Connect
1

Hi Community,

We’re looking for some guidance and, ideally, some formal documentation from Atlassian on the Forge siteId in the context of Forge Remote applications. We have been told informally and along the grapevine that the siteId ARI in the format: ari:cloud:jira::site/f9ee0ddz-59ea-45c3-8e1a-e73468d9539t is a unique identifier for Forge tenants, even across multiple installations/uninstallations of the same app. This being the case would make the siteId more valuable than the installationId for us, as we can accurately track the same Atlassian tenant’s usage of an app even in the case of an uninstall/reinstall.

We would really appreciate documentation on this, as we can’t find any at the moment. We are currently having to pick up secondhand information from other partners or informally by word of mouth or via our own experimenting, which doesn’t feel like a very ‘safe’ way to determine an API contract. For example, we are currently building our functionality for handling Forge install events, and can see this property in the Forge install event payload: "context": "ari:cloud:jira::site/f9ee0ddz-59ea-45c3-8e1a-e73468d9539t". Without documentation, though, we are unclear whether this will remain in place and whether it’s safe to consume.

Please could we get some guidance and documentation on this? Thanks!

14 Likes
2

I’d also appreciate such a documentation. What @GeorgeScott calls siteId is also often present in Forge event payloads as cloudId, just without the ari:cloud:jira::site/ prefix.

This seems to be a stable identifier not only when uninstalling/installing apps, but also when different apps get installed onto a tenant - and thus, making it easier for cross-app communication.

The cloudId is already present in connect (on forge) install events, Forge install events, Forge invocation tokens, other Forge events - please provide the guarantee that the cloudId/siteId will stay.

2 Likes
3

I’d also appreciate some clarity around cloudId/siteId.

Fun fact: As @AndreasSchrdercodefo found out, it’s not always a UUID which can be seen on https://ecosystem.atlassian.net/_edge/tenant_info, so better leave some more space and don’t expect a certain Regexp to match (e.g. when extracting cloudId from siteId).

2 Likes
4

Thanks for bringing this topic to our attention. We will work on providing guidance in the docs shortly

2 Likes