Skip to content

docs(dovetail): add proxy-only provider guide #620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
caiopizzol wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(dovetail): add proxy-only provider guide #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6838da6
docs(dovetail): add proxy-only provider guide
caiopizzol May 30, 2026
5c1e3be
docs(dovetail): add API token gif
caiopizzol May 30, 2026
31ff218
docs(dovetail): add nav entry via generate-docs.ts and regenerate doc…
caiopizzol May 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions src/generate-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Binary file added src/images/provider-guides/dovetail-api-token.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions src/provider-guides/dovetail.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.
Loading