API Key authentication passes along a user-entered API Key with every API call. In your Zapier integration using API Key authentication, the API key—and optionally any other data your API needs—is included every time a Zap step runs.
_Example API Key auth screen for users inside Zapier_
string
text field by default; select password
instead if you would like to obscure the data as users enter it.
– Help Text: Include a direct URL formatted with Markdown where users can obtain their API key from your app. If there is no direct link, include as clear of directions as possible to help users find the API key.
– Input Format: (optional) Help users figure out exactly what piece of data you need them to enter. For example, for a subdomain, https://.yourdomain.com/.
– Default Value: Include a value for this field to be used as a fallback. For optional fields, the default value is set on initial connection creation and used in the API call instead of missing or null values every time the Zap runs. For required fields, this value is used during connection creation, but not when the Zap runs (Zapier raises an error for missing/null values instead).
:censored:6:82a3be9927:
. Due to this, it is not possible to view the exact tokens or keys in Zapier’s logs. To verify that the same token as was returned by the authentication, is being used in subsequent API calls; you can compare censored value characters, for example :censored:6:82a3be9927:
would have the same value ending in 9927 when used in a subsequent call.
/user
or /me
call. Add the URL for the API call, and set the call type, typically a GET
. This will test the user-entered API key and any other credentials to ensure it enables a successful API call to your app.