Create an App Extension

miscBoltAlt icon Beta
App Extensions is a beta feature. It is available for use, but is still in active development and may change.
miscEye icon Advanced feature
  • To use this feature, you’ll need familiarity with sending HTTP requests, APIs, and reading API documentation.
  • If the app’s API changes, you may need to update your App Extensions.
  • Our Support team is able to provide basic troubleshooting for this feature, but they can't troubleshoot the API you use.
App Extensions is an advanced feature that allows you to create custom actions for existing app integrations using HTTP requests.
To create an App Extension:



1. Choose the app and event

In the Zap editor,
  • Click the Action step or 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 App Extensions (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.


3. Open the App Extensions builder

  • In the Action section, click App Extension Builder.


4. Add input fields 

Inputs fields allow you to send input data with your API request. Inputs field will then appear as fields in your custom action in the Zap editor. Read more about how input field settings interact with the Zap editor.
To add an input field:
  • In the Input Fields section, click + Add Input Field.
  • In the dialog box complete the required fields:
    • Key: A unique identifier for the field without spaces. Zapier recommends using the same key as your API.
    • Label: A user-friendly name for the field name.
  • (Optional) To further refine your input fields, you can use these fields to complete the following:
    • Help Text: Describe the purpose of this field.
    • Required?: Select the True checkbox, if this field is required. Leave unchecked if it’s optional.
    • Type: Select from the dropdown what type of data can be entered. Learn more about the different input field types.
    • List Options: Set up a predefined list with either a dynamic or static dropdown menu. Learn more about setting up a predefined list.
  • Click Done.
  • (Optional) To add in multiple inputs, repeat the add input field steps above.
If you have multiple inputs, you can also reorder how your inputs appear in the Zap editor. To reorder your inputs, click the click and drag icon icon and move the input into a new position.
ratingStar icon Tip

To reference inputs in the API Request, go to the API request tab and use double curly braces with its key. For example {{input_key}}.


5. Set up the API request

To set up your action, you must tell Zapier how to send data to the app’s API. Refer to the app’s API documentation for the method and URL.
To add your API request:
  • In the Action tab, complete the required fields:
    • Method: Select your API method from the Method dropdown menu.
    • URL: In the URL field, add the full URL of the endpoint.
  • Once you’ve completed all relevant fields, click Save.


5. Add query parameters (optional)

To add a query parameter to your API request, in the Query Parameters section:
  • Add a Key. The key is the name of the parameter.
  • Add a Value. The value is the data you want to associate with the parameter.
  • (Optional) Click the + icon to add additional query parameters.
  • Once you’ve completed all relevant fields, click Save.
Zapier will encode these keys and values into parameters and append them to the URL.


6. Add additional headers (optional)

To add additional headers to your API request, in the Additional Header section:
  • Add a Key. The key is the name of the header.
  • Add a Value. The value is the data you want to associate with the header.
  • (Optional) Click the + icon to add additional headers.
  • Once you’ve completed all relevant fields, click Save.
Zapier will apply these headers to the request and any headers created as part of the authentication process.  
miscEye icon Note
You do not need to add an authentication header. App Extensions uses the app’s authentication to connect to your app account.

7. Add a body (optional)

The Body field allows you to data (payload) as part of your API 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 the text contents within the Body field is valid.
Once you’ve completed the Body field, click Save.

8. Test the action

To ensure your action works as you expect it to in Zaps, Zapier recommends testing it.
To test your action:
  • Click the Test tab
  • Click the app account dropdown menu and select a connected app account.
  • In the Input Field Values section, you'll see listed all input fields from the API Request tab. Complete all required fields, as if you were setting up your action in your Zap.
  • Click Send test request.
  • In the API Response section, you’ll see the API response returned. The response logs will censor sensitive information, like API keys or authentication tokens. You can also download or copy the full response data should you need to troubleshoot the error further.
  • While testing, you may need to revise your App Extension settings. To quickly experiment, you can test these changes without saving.
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.
ratingStar icon Tip

You can click Reset Configuration to clear any input in the Test tab.

Once you’ve created your action, you can use it within your Zaps.  
For Teams or Company plan users, you can also share your action with teammates by going to the Action tab and clicking Publish.
For additional help, visit the Zapier Community's Code and webhook resources.
Was this article helpful?
0 out of 2 found this helpful