Endpoints - URLs required for Salesforce configuration

Owned by Jeff Gleeson
Last updated: Sept 20, 2023 by Jeff Gleeson
3 min read

The Connector provides a set of URLs that can be used by Salesforce to call on Jira functionality such as creating new issues or viewing related Jira issues from within a Salesforce object page.

These URLs are listed, for every Salesforce object mapping, under that object's mapping configuration under the Endpoints heading.

Locating the Endpoint URLs

To find the Endpoints for the Salesforce object mapping:

  1. Go to Cog Icon > Manage Apps.

  2. In the sidebar, under Cloud Connectors, click Mappings.

  3. Choose the desired Salesforce Object mapping and click Configure.

  4. At the Configure Mappings screen, you will see the > Endpoints label.
    Click on the > Endpoints label to display the Endpoint URLs table.

  5. You will see something similar to the following image:

URLs for configuring your Salesforce

The Endpoints URL table, when expanded, displays the list of possible actions Salesforce can call for this object.

The URLs associated with each action are available on that screen as reference for the Jira administrator to copy and paste into Salesforce during configuration.

URLs are not editable!

These URLs are not editable directly in Jira.

They are only made available in the Endpoints table for the Jira admin's reference for use while configuring Salesforce.

Anatomy of the Endpoints table

Below is an example of an Endpoints table from a system with a Jira URL of http://localhost:5130:

 


Reference

Field Name

Definition

Reference

Field Name

Definition

1

Create

URL used to access Jira action to create new issues.

2

Fetch

URL used to search for results in Jira. Used to grab related issues of a Salesforce object.

3

Pull Update

URL used to get update from Jira Issue especially with the not 1 to 1 relationship

4

Synchronize

URL used to sync details in the Salesforce object with the linked Jira issues.

5

Create or Update

Similar to #1 except it will provide an option to sync information if there are already some issues linked to the object. If there are not then the behavior is exactly as for #1.

6

Link

URL used to link Salesforce Object with Remote Object Link or Multi Remote Object Link field in Jira issue.
Replace {!Remote Object Link or Multi Remote Object Link Custom Field Id} with the Custom Field ID of the desired Remote Object Link or Multi Remote Object Link. (View sidebar for steps on getting the Custom Field ID.)

7

Associate

URL used to associate with more than one Jira issue with synchronize capability

Full list of Salesforce Objects

Please refer to the Salesforce documentation page for Standard Objects for the system name of your Salesforce object if it is not one of the above.

The Id field is always named as such and so the pattern for the syntax is:

{!<OBJECT_NAME>.Id}

Regarding Visualforce pages

For Visualforce pages only, the following syntax can be used generically for all objects:

{!$CurrentPage.parameters.id} Example: http://localhost:5130/plugins/servlet/customware/connector/issue/2/Case/fetch.action?id={!$CurrentPage.parameters.id}

Where do I find the Custom Field ID?

  1. Go to Cog Icon  > Issues.

  2. In the sidebar, under Fields, click Custom Fields.

  3. Choose your desired custom field, then click on the pull-down menu on the right, and click Configure.

  4. Now look at the address bar at the top.
    At the end of the URL, you should see something similar to this:
    "customFieldId=xxxx", where xxxx is your Custom Field ID.