Create a Custom Action

Beta

Custom Actions are a beta feature. It is available for use, but is still in active development and may change.

Custom Actions allows you to create customized actions for existing apps on Zapier. You can create Custom Actions for many supported public apps.

There are two builders you can create Custom Actions with:

  • Simple: Use a template or create your custom action manually.
  • Create with AI: Use an AI Assistant to craft your custom action
miscEye icon Note
  • 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 custom actions.
  • Our Support team can provide basic troubleshooting for this feature, but they can't troubleshoot the API you use.
Simple Builder Create with AI Builder

To create a custom action using the Simple Builder:

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 Custom Action (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 Custom Action Builder

  • In the Action section, click Custom Action Builder.
  • Select Start Simple.

4. Auto-fill your API Request settings with AI

To speed up the process of setting up your custom action, you can use AI to auto-fill the API request settings.

  • In the AI Assist box, describe your desired action. Describe your action using plain language. You do not need to use technical language.

Custom Action: Simple builder

  • Click Generate.
  • A pop-up window will appear, asking you to agree to Zapier’s AI terms to use this feature. Click Agree and Continue.
  • A new modal will appear below with suggested custom actions.
  • Click Build.
  • Next, you can:
    • Click Preview to review the suggested custom action.
    • Click Use to auto-fill the API Request settings.
actionEdit icon Example

You can enter prompts like:

  • Slack App: “Get all the messages from a thread”
  • Hubspot App: “Update the status of a deal”
  • Pandadocs App: “Send a document without sending an email”

5. Add the input fields (optional)

Input fields allow you to send input data with your API request. Inputs will then appear as fields in your custom action in the Zap editor. Read more about how input settings interact with the Zap editor.

To add an input field:

  • In the Input Fields section, click + Add Input.
  • In the dialog box complete the required fields:
    • Key: A unique identifier for the field, without spaces. Zapier recommends to use 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: Setup a pre-defined list with either a dynamic or static dropdown menu. Learn more about setting up a pre-defined list.
  • Click Done.
  • (Optional) To add in multiple inputs, repeat the add input field steps above.
  • Once you’ve added your input field, click Save.

If you have multiple inputs, you can also reorder how your inputs appear in the Zap editor. To reorder your inputs, click the drag icon drag icon and move the input into a new position.

ratingStar icon Tip

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

6. Add the API request (optional)

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 section, 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.

7. 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.

8. 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.

9. 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.

10. Test the action

To ensure your action works as expected in Zaps, Zapier recommends testing your custom action.

  • Click the Test tab.
  • Click the app account dropdown menu and select a connected app account.
  • In the Input Field Values section, complete any of the required fields to test your custom action.
  • Click Send test request.
  • You can review your API response to see if it worked as expected. 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.
  • (optional) You can reset your test data by clicking Reset Configuration.
miscEye icon Note
  • An API error may still result in a task completing successfully.
  • It’s expected behavior that an API’s error message will not appear in the Zap editor or Zap history.
  • Always manually verify the API Request settings generated by AI to ensure the custom action is accurate and works as expected.

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?
5 out of 7 found this helpful