Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

See some examples of common connections below.

UI Expand
expandedtrue
titleConnections

Each remote action uses a connection to which the request is sent. This can either be an internal connection that helps to overcome some platform limitations or an external one. These connections can be created directly within the Execute remote action post function or on the Remote actions page at the Connections tab in the Manage apps administration. There, you can furthermore copy, edit and delete the connections or get information on whether they are used or not.


UI Expand
titleCreate a connection


UI Expand
titleName
Define the name of the connection. The name must be unique across all configured connections.


UI Expand
titleConnection type

Select whether to create an internal or an external connection. Although there is a usable default internal connection authenticated as the logged-in user, you can create further internal connections with a dedicated authentication.


Info

Expert tip: On the cloud platform, not all REST endpoints are available for a 3rd party app like Jira Workflow Toolbox. If you want to use such an endpoint, you can overcome this limitation by creating an external connection using the current site URL and passing the authentication of a privileged user instead of using the internal one.



UI Expand
titleBase URL
If the connection is configured as external, the base URL of the remote service needs to be defined. The base URL has to start with http or https and will be concatenated with the REST path configured in the action when executing the action.


UI Expand
titleAuthentication

Select the authentication used for the connection.

OptionConnection typeDescription
Current userCurrent instanceThe logged-in user will be used to execute the remote action.
Selected userCurrent instanceIndependent of the logged-in user, the selected user will be the one executing the remote action.
No authenticationExternalNo authentication details will be passed when executing the remote action. This option can be used to connect to anonymous accessible web services.
BasicExternalA username and password combination will be used to execute the remote action.
BearerExternalAn API token will be passed when executing the remote action.




UI Expand
titleEdit a connection

On the Remote actions page at the Connections tab in the Manage apps administration , you are able to edit a connection by just clicking the edit icon on the connection that you want to update.


UI Expand
titleCopy a connection

On the Remote actions page at the Connections tab in the Manage apps administration , you are able to copy a connection by just clicking the copy icon on the connection that you want to copy. Most configurations are taken over except the credentials in case of an external connection. As the name has to be unique across all remote connections, you have to update at least the connection name parameter. 


UI Expand
titleDelete a connection

On the Remote actions page at the Connections tab in the Manage apps administration , you are able to delete a connection by just clicking the delete icon on the connection that you want to delete. If the connection is used in any connection as a default connection, you need to update the affected actions first. Please keep in mind that deleting a connection might result in an invalid workflow configuration in case it is still in use. 

UI Expand
expandedtrue
titleConnection examples
UI Expand
titleConfluence Cloud
Connection typeExternal
Base URL<http://yourInstance.atlassian.net/wiki>
AuthenticationBasic
Username<yourAtlassianID> (email address)
Password<API token> (generated via https://id.atlassian.com/manage-profile/security/api-tokens)
UI Expand
titleConfluence Server and Data Center
Connection typeExternal
Base URL<http://yourBaseURL>
AuthenticationBasic
Username<username>
Password<password>
UI Expand
titleHubSpot
Connection typeExternal
Base URLhttps://api.hubapi.com/
AuthenticationBearer
Password<API token> (see https://developers.hubspot.com/docs/api/private-apps)
UI Expand
titleJira Cloud
Connection typeExternal
Base URL<yourInstance.atlassian.net>
AuthenticationBasic
Username<yourAtlassianID> (email address)
Password<API token> (generated via https://id.atlassian.com/manage-profile/security/api-tokens)
UI Expand
titleJira Server and Data Center
Connection typeExternal
Base URL<http://yourBaseURL>
AuthenticationBasic
Username<username>
Password<password>