Skip to content

fix(monday): document API key auth setup (not OAuth)#612

Merged
laurenzlong merged 2 commits into
amp-labs:mainfrom
caiopizzol:caiopizzol/fix-monday-api-key-auth
May 26, 2026
Merged

fix(monday): document API key auth setup (not OAuth)#612
laurenzlong merged 2 commits into
amp-labs:mainfrom
caiopizzol:caiopizzol/fix-monday-api-key-auth

Conversation

@caiopizzol
Copy link
Copy Markdown
Contributor

@caiopizzol caiopizzol commented May 18, 2026

Description

The current monday.mdx walks users through creating a Monday OAuth app and entering Client ID + Client Secret into the Ampersand Dashboard's provider-app form. That form doesn't exist for Monday in the current Dashboard — selecting Monday from the Create OAuth Provider App dropdown shows "No options" because Monday is API-key authenticated, not OAuth.

Verified against three sources:

  • Live /v1/providers: monday.authType == "apiKey", apiKeyOpts.header.name == "Authorization".
  • amp-labs/connectors/providers/monday.go: AuthType: ApiKey.
  • Monday's own authentication documentation: personal API tokens are passed in the Authorization header.

Users following the prior guide would hit a dead end at the "Enter Client ID / Client Secret" step.

Changes:

  • Replace OAuth provider-app setup with an API-token setup section mirroring Monday's official labels (profile picture → DevelopersAPI token > Show).
  • Remove the Add Monday app details in Ampersand section. API-key providers don't need a provider app in Ampersand; the customer enters their token during the InstallIntegration flow.
  • Add the clarifying sentence that the InstallIntegration component prompts the customer for their Monday API token.
  • Fix # Using the connector## Using the connector (was H1 inside an H2-only structure).
  • Add .env to .gitignore.

Out of scope:

  • The Write Actions claim in this guide remains untouched. The catalog says support.write: false while a real Write API call to boards succeeds — that's tracked separately in amp-labs/connectors#3003.
  • monday-amp-project.png becomes orphaned after this change but is left on disk; cleanup of orphaned images can be a separate sweep.

Screenshot

image

Monday is API-key authenticated per the live provider catalog and the
connector source (providers/monday.go: AuthType: ApiKey, header
Authorization). The existing guide walked users through creating an
OAuth app and entering Client ID/Secret into the Ampersand Dashboard's
provider-app form, but that form shows 'No options' for Monday in the
current Dashboard. Users following the prior guide would hit a dead
end.

Changes:
- Replace OAuth provider-app setup with an API-token setup section
  that mirrors Monday's official auth docs verbatim (profile picture
  -> Developers -> API token > Show).
- Remove the 'Add Monday app details in Ampersand' section entirely;
  API-key providers do not need a provider app in Ampersand.
- Note that the InstallIntegration component prompts the customer for
  their Monday API token directly.
- Fix '# Using the connector' -> '## Using the connector' (was H1
  inside an H2-only structure).

Out of scope for this PR:
- Write Actions support claim (tracked in amp-labs/connectors#3003).
- Cleanup of the now-orphaned monday-amp-project.png screenshot; the
  file is left on disk and can be removed in a separate sweep.

Also: add .env to .gitignore so local secrets don't surface in PRs.
Compressed via gifsicle (-O3 --lossy=300 --colors 64 --scale 0.7) to
2.0 MB at 514x336. Lands within the peer api-key GIF size range
(1.2-2.6 MB existing in repo).
@laurenzlong laurenzlong merged commit fb8d1e8 into amp-labs:main May 26, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants