Release notes for new versions of the Paragon REST 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:
/projects/:projectId/sdk/integrations
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.
In GET /projects/:projectId/sdk/integrations
, some unnecessary fields are being removed from Integrations:
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.dateCreated
integration.customIntegration.dateUpdated
integration.customIntegration.projectId
integration.customIntegration.oauthScopes
integration.customIntegration.oauthIncludeClientAuthorizationHeader
integration.customIntegration.usePKCEInCodeExchange
integration.customIntegration.apiBaseUrl
integration.customIntegration.testEndpointPath
integration.customIntegration.isTestEndpointVerified
integration.customIntegration.apiAuthorization
integration.customIntegration.userProfileConfig
Other non-breaking changes:
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:
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
.Release notes for new versions of the Paragon REST 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:
/projects/:projectId/sdk/integrations
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.
In GET /projects/:projectId/sdk/integrations
, some unnecessary fields are being removed from Integrations:
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.dateCreated
integration.customIntegration.dateUpdated
integration.customIntegration.projectId
integration.customIntegration.oauthScopes
integration.customIntegration.oauthIncludeClientAuthorizationHeader
integration.customIntegration.usePKCEInCodeExchange
integration.customIntegration.apiBaseUrl
integration.customIntegration.testEndpointPath
integration.customIntegration.isTestEndpointVerified
integration.customIntegration.apiAuthorization
integration.customIntegration.userProfileConfig
Other non-breaking changes:
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:
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
.