Set up an API Request action

Beta

API Request action is a beta feature. It’s available for use, but still in active development and may change.

miscEye icon Advanced feature
  • To create an API Request action, you’ll need familiarity with sending HTTP requests, APIs, and reading API documentation.
  • Our Support team is able to provide basic troubleshooting for this feature, but they can't troubleshoot the API you use.
 
 
The API Request action is an advanced feature that allows you to make raw HTTP requests within the Zap editor.  
 

Prerequisites

1. Choose the app and event

In the Zap editor:
  • Click the Action step, or click the plus + icon to add an action to your Zap.
  • Search for or select the app you want to use in your action.
  • Click the Event dropdown menu.
  • Select API Request (Beta).

 

2. Connect your account

  • If you already have an account connected to Zapier for the app, select it from the account menu.
  • If not, click Connect a new account and follow the instructions to connect your app to Zapier.
  • Once the connection is working, click Continue.
miscEye icon Note

API Request actions can't be used with shared app connections.

 

3. Set up the API Request action

Required fields
  • Select an HTTP Method from the dropdown menu.
  • In the URL field, enter the full URL of the endpoint. 
miscEye icon Note

If you add a URL containing parameters to the URL field, your request will ignore them. To add parameters, use the Query String Parameters field.

Optional fields
  • Use the Query String Parameters to refine the request. Any parameters added will be URL-encoded and appended to the URL when making the API request.
  • Use the Additional Request Headers to pass on additional information, if applicable, to your API.
miscEye icon Note

You do not need to add an authentication header. It's added automatically when you connect your app account.

  • Use the Body field to pass a payload in the request. By default, Zapier will pass the body as raw text. If your API expects requests in a certain format, such as JSON, you must ensure text contents within the Body are valid
After filling in all required fields and any optional fields, click Continue to move to the final step.
 
 

4. Test the API Request action

  • Click Test action.
  • The next screen will show if Zapier can perform the action step successfully. To see the full response data, copy the URL in the field :mag:_full_response_data_:mag_right: and paste it into a new browser tab.
miscEye icon Note
  • An API error may still result in a task completing successfully. To view API errors, download the full response data.
  • It’s expected behavior that an API’s error message will not appear in the Zap editor or Zap History.
  • The response logs will censor sensitive information, like API keys or authentication tokens.
 
Once you’ve set up your API Request action, you can either:
    • Add another action step.
    • Turn your Zap on by clicking Publish Zap.

 

For additional help, visit the Zapier Community's Code and webhook resources.

Was this article helpful?
4 out of 22 found this helpful