diff --git a/src/docs.json b/src/docs.json index 18dc2be0..36de9503 100644 --- a/src/docs.json +++ b/src/docs.json @@ -123,6 +123,7 @@ "provider-guides/dixa", "provider-guides/docusign", "provider-guides/domo", + "provider-guides/dovetail", "provider-guides/drift", "provider-guides/dropbox", "provider-guides/dropboxsign", diff --git a/src/generate-docs.ts b/src/generate-docs.ts index fa78cb95..6e680eb6 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -354,6 +354,7 @@ const baseConfig = { "provider-guides/dixa", "provider-guides/docusign", "provider-guides/domo", + "provider-guides/dovetail", "provider-guides/drift", "provider-guides/dropbox", "provider-guides/dropboxsign", diff --git a/src/images/provider-guides/dovetail-api-token.gif b/src/images/provider-guides/dovetail-api-token.gif new file mode 100644 index 00000000..abf91d9c Binary files /dev/null and b/src/images/provider-guides/dovetail-api-token.gif differ diff --git a/src/provider-guides/dovetail.mdx b/src/provider-guides/dovetail.mdx new file mode 100644 index 00000000..2d95d5e4 --- /dev/null +++ b/src/provider-guides/dovetail.mdx @@ -0,0 +1,36 @@ +--- +title: "Dovetail" +--- +## What's supported + +### Supported actions + +This connector supports: +- [Proxy Actions](/proxy-actions), using the base URL `https://dovetail.com/api`. + +### Supported objects + +Dovetail is supported through Proxy Actions only. Use the proxy to call any [Dovetail Public API](https://developers.dovetail.com/reference) endpoint, for example `GET /v1/projects`. + +## Before you get started + +This connector uses API Key authentication. You do not need to create a provider app in the Ampersand Dashboard. + +### Create a Dovetail API token + +1. Go to your [Dovetail account settings](https://dovetail.com/settings/user/account). +2. Enter a label for the key and create it. +3. Copy the token and store it securely. Dovetail shows it only once. + +![Dovetail API token creation](/images/provider-guides/dovetail-api-token.gif) + +Dovetail API tokens are prefixed with `api.`. For details, see Dovetail's [authorization documentation](https://developers.dovetail.com/docs/authorization). + +## Using the connector + +To start integrating with Dovetail: + +- Create a manifest file using the [proxy-only example](https://github.com/amp-labs/samples/blob/main/dovetail/amp.yaml). +- Deploy it using the [amp CLI](/cli/overview). +- Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their Dovetail API token. +- Start making [Proxy Actions](/proxy-actions) API calls against `https://dovetail.com/api`.