Name

Provides a name for the Connector to be shown in the Cyclr interface.

CreatedOnUtc

The date and time when the Connector file was created (in UTC timezone). Will be used to identify when a Connector should be updated in Cyclr. Format: “2015-12-14T11:20:00.000Z”. Leave the seconds and milliseconds as zeros (not that precise).

Description

Provides a description for the Connector to be shown in the Cyclr interface. This should describe, in a sentence, what the app does.

Version

This is the version of the product’s API which doesn’t necessarily match the version of the product itself.

AuthType

This specifies what type of authentication is used by the remote endpoint.

  • ApiKey – the user should provide an API key as the HTTP header for the connector. Requires: AuthScheme (HTTP header field name).
  • Basic – the API uses HTTP basic authentication.
  • OAuth1 – the API uses OAuth 1.0a authentication. Requires: ClientId (also known as ConsumerKey), ClientSecret (also known as ConsumerSecret), RequestTokenUrlAuthorizeUrlAccessTokenUrl.
  • OAuth2 – the API uses OAuth 2 authentication. Requires: ClientIdClientSecretAuthoriseUrlAccessTokenUrl.
  • None – no authentication required.
  • AuthFields – the API needs to inject authentication fields into the POST message. Requires: NameKeyType.

OAuth2Type

This field will only be used if the AuthType is OAuth2.

  • AuthorisationCode (Default) – the client will redirect the user to the authorization server, the user will then be asked to login to the authorization server and approve the client.
  • ClientCredentials – client will get the access token from the authorization server without user challenge.
  • PasswordCredentials – client will get the access token from the authorization server using username & password.

Icon

Your connector needs an icon.

  • Minimum: square @ 256px x 256px
  • 24-bit PNG on a transparent background

Learn About Custom Connector Parameters & Triggers 

Edit me