How to Update the orgWideAccess Property for a Custom Integration

This guide walks you through enabling org-wide access for a custom integration (connector) in Pipe17. You'll fetch the connector details via the API, update the orgWideAccess property, and then apply the change from the Pipe17 UI.

Before you begin: You'll need API access and the connector's Connector API Key. These steps involve direct API calls, so basic familiarity with curl (or a tool like Postman) is helpful.

What you'll need

Item	Where to find it
Connector API Key	Integration details page → API Key tab → Connector API Key
Connector ID	Integration details page (shown in the connector URL / details)

Step 1: Get the Connector API Key

Open the integration's details page in Pipe17.
Go to the API Key tab.
Locate the Connector API Key section.
If you don't already have the key saved, click Regenerate key to generate a new one and copy it.

API Key tab showing the Integration API Key field and the Connector API Key with a Regenerate key link.

Note: Regenerating the key invalidates the previous key. Make sure any existing systems using the old key are updated.

Step 2: Get the Connector ID

Find the Connector ID on the integration details page. You'll use this ID in each of the API calls below.

In the examples that follow, the placeholder Connector ID is 03fc47771fc3517d. Replace it with your own.

Step 3: Fetch the current connector details

Use your Connector API Key to retrieve the connector's current configuration.

curl --location 'https://api-v3.pipe17.com/api/v3/connectors/03fc47771fc3517d' \
--header 'Accept: application/json' \
--header 'X-Pipe17-Key: <connector-key>'

Replace:

03fc47771fc3517d with your Connector ID
<connector-key> with your Connector API Key

Step 4: Check the current orgWideAccess value

In the response from Step 3, find the orgWideAccess field.

If orgWideAccess is false, continue to the next step.
If orgWideAccess is already true, no action is needed. You're done.

Step 5: Note the current version

In the same response, find the version field and note its current value (for example, 1.1).

You'll increase this version number in the next step so the UI recognizes that an upgrade is available.

Step 6: Update the connector

Send a PUT request to set orgWideAccess to true and bump the version number.

curl --location --request PUT 'https://api-v3.pipe17.com/api/v3/connectors/03fc47771fc3517d?keys=' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Pipe17-Key: <connector-key>' \
--data '{
  "orgWideAccess": true,
  "version": "1.1"
}'

Replace:

03fc47771fc3517d with your Connector ID
<connector-key> with your Connector API Key
"version": "1.1" with a version number higher than the current value you noted in Step 5

Important: The new version must be greater than the current version. This is what triggers the Upgrade Available prompt in the UI.

Step 7: Verify the update via the API

Fetch the connector details again to confirm that orgWideAccess is now true and the version was updated correctly.

curl --location 'https://api-v3.pipe17.com/api/v3/connectors/03fc47771fc3517d' \
--header 'Accept: application/json' \
--header 'X-Pipe17-Key: <connector-key>'

Confirm in the response that:

orgWideAccess is true
version matches the value you set in Step 6

Step 8: Apply the upgrade in the UI

Go to the integration's details page in Pipe17.
Refresh the page.
You should now see an Upgrade Available button next to the integration name.
Click Upgrade Available.

![Integration details page with the Upgrade Available button and the connector version highlighted.]

In the Upgrade Integration confirmation dialog, click Confirm.

Upgrade Integration confirmation dialog asking to confirm the upgrade to the new version.

Upgrading may change some of your integration configurations, as noted in the confirmation dialog.

Step 9: Confirm the version in the UI

After confirming, verify that the version displayed on the integration page matches the version you set in Step 6. If it matches, the orgWideAccess update has been successfully applied.

Troubleshooting

Issue	What to check
Upgrade Available button doesn't appear	Make sure the new version in Step 6 is higher than the previous version, then refresh the page.
API call returns an authorization error	Confirm you're using the Connector API Key (not the Integration API Key) and that it hasn't been regenerated since you copied it.
orgWideAccess still shows false after the PUT	Re-run Step 7 to confirm the update was accepted, and verify you targeted the correct Connector ID.

Need Help?

If you need additional assistance:

Use Ask Pippen, our AI agent, located at the top of the app page.
Submit a support request with as much relevant detail as possible. Learn how to submit a request.
For urgent issues, email us directly at support@pipe17.com.