API Release Notes

​

Updates to GET /sdk/integrations and Proxy API

To improve the ergonomics of the API, we are introducing a few changes to the GET /projects/:projectId/sdk/integrations and Proxy API endpoints for Custom Integrations.

We are also removing some unnecessary fields from the response of the GET /projects/:projectId/sdk/integrations endpoint to improve performance. Please review these changes to ensure that your application is not using any of the fields scheduled for removal.

Affected endpoints:

• GET /projects/:projectId/sdk/integrations
• Proxy API

Breaking changes:

• In GET /projects/:projectId/sdk/integrations, the type field of Custom Integrations will now be the full slug that is used in paragon.connect() calls.

  Show Example

  Copy

  Ask AI

  {
      "id": "77210f70-4f20-4eac-bded-825732b229c3",
      "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
      "customIntegrationId": "d8fe6169-8119-4cb0-a7a9-c2b18aff2c07",
      "name": "Example",
  -   "type": "custom",
  +   "type": "custom.example",
      "isActive": true,
      "configs": [...],
      "workflows": [...],
      "customIntegration": {
          "id": "d8fe6169-8119-4cb0-a7a9-c2b18aff2c07",
          "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
          "name": "Example",
          "isPublished": true,
          "slug": "custom.example"
      },
      "hasCredential": true,
      "connectedUserLimitOnDevCred": 0,
      "connectedUserLimitReached": false,
      "brandColor": "#000000",
      "needPreOauthInputs": false,
      "authenticationType": "oauth",
      "sdkIntegrationConfig": null
  }
  

• In GET /projects/:projectId/sdk/integrations, some unnecessary fields are being removed from Integrations:

  • To optimize the performance of this endpoint, some fields of Integrations are being removed. Please ensure that the following fields are not in use by your application:
    • integration.dateCreated
    • integration.dateUpdated
    • integration.resourceId
    • integration.configs[].dateCreated
    • integration.configs[].dateUpdated
    • integration.configs[].integrationId
    • integration.workflows[].dateCreated
    • integration.workflows[].dateUpdated
    • integration.workflows[].teamId
    • integration.workflows[].isOnboardingWorkflow
    • integration.workflows[].workflowVersion
    • integration.customIntegration.oauthScopes
    • integration.customIntegration.oauthIncludeClientAuthorizationHeader
    • integration.customIntegration.usePKCEInCodeExchange
    • integration.customIntegration.apiBaseUrl
    • integration.customIntegration.testEndpointPath
    • integration.customIntegration.isTestEndpointVerified
    • integration.customIntegration.apiAuthorization
    • integration.customIntegration.userProfileConfig

  Show Example

  Copy

  Ask AI

  {
      "id": "949b090a-b727-46f3-b2b4-831dd1baf866",
  -   "dateCreated": "2023-10-23T17:03:16.211Z",
  -   "dateUpdated": "2023-10-23T17:03:16.211Z",
      "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
      "customIntegrationId": null,
  -   "resourceId": null,
      "type": "stripe",
      "isActive": true,
      "configs": [
          {
              "id": "a1d2c290-c388-4d58-9a78-ea999df243ed",
  -           "dateCreated": "2023-10-23T17:03:16.211Z",
  -           "dateUpdated": "2023-10-23T17:03:16.211Z",
  -           "integrationId": "949b090a-b727-46f3-b2b4-831dd1baf866",
              "values": {
                  "overview": "Connect your Stripe account...",
                  "accentColor": "#32325D",
                  "description": "Sync customers or payments from Stripe",
                  "workflowMeta": {
                      "0d8372ab-5a4b-45d9-8ed9-903e3b3925a3": {
                          "id": "0d8372ab-5a4b-45d9-8ed9-903e3b3925a3",
                          "inputs": [],
                          "infoText": "Add a user-facing description of this workflow"
                      }
                  }
              }
          }
      ],
      "workflows": [{}],
  -   "customIntegration": null,
      "hasCredential": false,
      "connectedUserLimitOnDevCred": 0,
      "connectedUserLimitReached": false,
      "name": "Stripe",
      "brandColor": "#32325D",
      "needPreOauthInputs": true,
      "providerType": "stripe",
      "authenticationType": "basic",
      "sdkIntegrationConfig": {...}
  }
  

Other non-breaking changes:

• Proxy API now supports using the custom.name format when sending Proxy requests for Custom Integrations

  • Instead of passing in a customIntegrationId, you will now be able to pass in custom.name (the same slug used for paragon.connect) directly to the Proxy API.

  • Example:

    Copy

    Ask AI

    - https://proxy.useparagon.com/projects/:projectId/sdk/proxy/custom/:customIntegrationId/:path
    + https://proxy.useparagon.com/projects/:projectId/sdk/proxy/custom.integrationName/:path
    
    

​

What do I need to do?

• Verify that your use of integrations.type for Custom Integrations does not rely on the value being exactly "custom". The new type field will include the full slug value, e.g. custom.integrationName.
• Verify that you are not using any of the fields scheduled for removal from the API.

​

When are these changes being released?

• These changes will be released on July 7, 2025.