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 your own actions for existing apps on Zapier. You can create custom actions for supported public apps.

miscEye icon Note
  • To use this feature, you’ll need to be familiar with sending HTTP requests, using 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.
  • Custom actions created with the Start Simple Builder have been converted to API Request actions. Learn more in this release note.

 

1. Open the Custom Action Builder

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 Create action to open the Custom Action Builder.
  • Select Create with AI.

2. Chat with Copilot

In the left panel, is where you can chat with Copilot.

Start by telling Copilot the custom action you want to create. Describe your action using plain language. You do not need to use technical language. This will then start the process of:

  • Finding the right API endpoints to use.
  • Generate the code for the API endpoints.

This will take a few minutes to load. Depending on your input, you may be asked follow-up questions. This ensures Copilot can generate the right action for you. Once complete, you’ll receive a summary that covers:

  • Inputs
  • Logic
  • Outputs
  • API Endpoints Used

Review the summary to see if the action matches your needs. Then, you can continue to talk back and forth with the Copilot to refine it.

actionEdit icon Example

In this scenario, you want to create a new action to create a new page in your Coda document using the Coda app. Send the AI Chatbot message “Create a new page”.

The summary returned will include:

  • Inputs: The Coda information required to create a new page for the API request.
  • Logic: How the API request functions to create a page and parse the API response.
  • Outputs: What information the API response returns on the new page.
  • API Endpoint Used: The Coda API endpoint.

example of AI Assistant creating a custom action.png

 

miscEye icon Note

Zapier is aware of a bug where input fields are not always generated. To work around this issue, create an action using API Request actions.

Verify the API endpoint

Before proceeding, it’s important to verify that the API endpoint you’re using is current and not deprecated. You can ask the AI Chatbot for a link to the app’s API documentation. This will have the information you need to confirm the endpoint’s status.

miscEye icon Note

Zapier recommends verifying the AI output, as you would with any other source. Like any tool, AI can be helpful, but not perfect. AI hallucination can happen, meaning it may generate incorrect or misleading information.

3. Undo changes (optional)

As you chat with Copilot, you may want to restore a previous version of your action. To do this:

  • Click Undo changes. The page will refresh, showing all previous prompts.
  • Click on a prompt to return to the previous version.
  • Click .

4. Give Copilot feedback (optional)

While you are using Copilot, you can give feedback at any point by marking a conversation with either the thumbs up or thumbs down button. Your rating and conversation are shared to help Copilot improve the answers it provides and enhance your experience of creating an action. 

Zapier uses feedback shared by customers to improve our products.

Give Copilot feedback on conversations when creating a custom action.png

5. Edit your action with code (optional)

In the left panel, click the Advanced tab to show you:

  • API Endpoints: What the API request and response is for your custom action. You can also copy these to test in an external environment.
  • Code: You can use the code editor to refine the generated code using Typescript. All changes will be automated saved.

Code editor in the Custom Action Builder.png

6. Test the action

In the right panel, test your action. You can view all of the Input fields and how they would appear in the Zap editor.

Advanced settings of the Create with AI Builder.png

To test your action:

  • In the Authorization section, select an app connection.
  • In the Inputs section, complete all the required fields.
  • Click Run Test.
  • Your Test Results will take a few minutes to load and will provide a detailed log of the API response. The response logs will censor sensitive information, like API keys or authentication tokens
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.

7. Add your action to the Zap editor

  • In the bottom right corner, click Publish.
  • Once published, you'll then see your Custom Action title with ("Custom Action)" in the Event dropdown menu. You and your teammates on your Zapier account will be able to use it in your Zaps.

example of a custom action appearing in the event options in the Zap editor.png

 

Additional resources

Was this article helpful?
18 out of 26 found this helpful