Skip to content

fix(proxy-actions): clarify x-amp-project-id header requires UUID #613

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 1 commit into
base: main
Choose a base branch
from
Open

fix(proxy-actions): clarify x-amp-project-id header requires UUID #613

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/proxy-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Please refer to the [Provider Guides](/provider-guides) for the base URL of each
Keep the request body and HTTP verb the same, and add these additional headers so Ampersand knows how to deliver the API request:

* `x-amp-proxy-version`: this should always be 1
* `x-amp-project-id`: your Ampersand project ID. You can find it on your project's [General Settings page](https://dashboard.withampersand.com/projects/_/settings)
* `x-amp-project-id`: your Ampersand project UUID, not the project name. You can find it on your project's [General Settings page](https://dashboard.withampersand.com/projects/_/settings). Unlike Platform API paths that accept either project name or UUID, this header requires the UUID.
* `x-api-key`: your Ampersand API key, if you don't have one yet, create one in the Ampersand Dashboard's [API Keys page](https://dashboard.withampersand.com/projects/_/api-keys).

In order for Ampersand to know which SaaS instance to make the API call against, you'll need to provide either:
Expand All @@ -40,7 +40,7 @@ Here is an example API call:
```bash
curl --location --request PUT 'https://proxy.withampersand.com/services/data/v56.0/sobjects/Account' \
--header 'Content-Type: application/json' \ # Other content types are supported
--header 'x-amp-project-id: my-ampersand-project-id' \
--header 'x-amp-project-id: <PROJECT_UUID>' \
--header 'x-api-key: my-api-key' \
--header 'x-amp-proxy-version: 1' \
--header 'x-amp-integration-name: my-salesforce-integration' \
Expand Down
Loading