Skip to main content
Best answer

What response is required to validate success or failure of API Key?

  • December 24, 2021
  • 1 reply
  • 263 views

Hi,

There were issues with the OAuth Server setup, so we resorted to APIKey authentication, right now its getting the json response as returned from the API method. Is there any specific response that is required from Zapier end for validating success or failure of API Key? The current response is sent with code 200 for success  and 201 for failure. The json array passed from our end is 

{
  "success": "true"
}

Thanks,

Anitha

Best answer by mzsadiek

Hi @Anitha Sabareesh! You can find documentation around API Key Auth here: https://platform.zapier.com/docs/apikey

And here you can find common error responses: https://platform.zapier.com/docs/auth#test

Zapier does not expect a specific success response from your API for the authentication. If you see it returns success 200, it should be fine.

This post has been closed for comments. Please create a new post if you need help or have a question about this topic.

1 reply

mzsadiek
Forum|alt.badge.img+5
  • Zapier Solution Partner
  • Answer
  • December 24, 2021

Hi @Anitha Sabareesh! You can find documentation around API Key Auth here: https://platform.zapier.com/docs/apikey

And here you can find common error responses: https://platform.zapier.com/docs/auth#test

Zapier does not expect a specific success response from your API for the authentication. If you see it returns success 200, it should be fine.