API Docs / Schemas / CreateThirdPartyConnectionRequest

CreateThirdPartyConnectionRequest

Request for creating a new ThirdPartyConnection

Properties

Name Type Description
namestring

Display name for the connection

Display name for the connection

redirectUrlstring

URL to redirect the user to after OAuth flow completes.
If you use [code] in the url then we'll replace it with the Code of this ThirdPartyConnection.
This solves the problem of not knowing the code at creation time.

URL to redirect the user to after OAuth flow completes.
If you use [code] in the url then we'll replace it with the Code of this ThirdPartyConnection.
This solves the problem of not knowing the code at creation time.

platform*string

The platform identifier (e.g., "Xero", "FreeAgent", "Xama")

The platform identifier (e.g., "Xero", "FreeAgent", "Xama")

oAuthClientIdstring

OAuth client ID for OAuthClientCredentials flow (e.g., Xama OAuth ID)

OAuth client ID for OAuthClientCredentials flow (e.g., Xama OAuth ID)

oAuthClientSecretstring

OAuth client secret for OAuthClientCredentials flow (e.g., Xama OAuth Secret)

OAuth client secret for OAuthClientCredentials flow (e.g., Xama OAuth Secret)

organizationIdstring

External organization/client ID for OAuthClientCredentials flow (e.g., Xama Client ID)

External organization/client ID for OAuthClientCredentials flow (e.g., Xama Client ID)

JSON Example

{
  "name": "string",
  "redirectUrl": "string",
  "platform": "string",
  "oAuthClientId": "string",
  "oAuthClientSecret": "string"
}

Used By Operations