Returns information about a single provider. No authentication is required.
The provider name (e.g. salesforce, hubspot).
The requested provider.
The type of authentication required by the provider.
oauth2, apiKey, basic, jwt, custom, none The base URL for making API requests.
The supported features for the provider.
Configuration for OAuth2.0. Must be provided if authType is oauth2.
Configuration for API key. Must be provided if authType is apiKey.
Configuration for Basic Auth. Optional.
Configuration for custom auth. Optional.
A URL to check the health of a provider's credentials. It's used to see if the credentials are valid and if the provider is reachable.
The display name of the provider, if omitted, defaults to provider name.
"Zendesk Chat"
If true, we require additional information after auth to start making requests.
true
Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.
The registry of provider modules.
Provider metadata that needs to be given by the user or fetched by the connector post authentication for the connector to work.
Describes the provider-app-level fields that the Ampersand dashboard should collect from the builder when creating a ProviderApp for this provider. These descriptors tell the dashboard which form fields to render; the submitted values are stored in ProviderApp.metadata.