Create a custom action

Custom Actions allows you to create your own actions for existing apps on Zapier with the help of AI. You can create custom actions for supported public apps.

Beta

Custom Actions is in open beta. It's available for use, but still in active development and may change.

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 cannot troubleshoot the API you use.

1. Open the Custom Action Builder

You can open the Custom Action Builder from the Zap editor or from the Custom Actions library.

In the Zap editor:

• Click the Action step, or click the plus + icon to add an action step to your Zap.
• Search for and select the app you want to use in your action.
• Click the Action event dropdown menu to expand it.
• Select the Custom actions tab.
• Click + Create action to open the Custom Actions set up wizard.

Your app is already selected, because you chose it on the action step.

In the Custom Actions library:

• In the left sidebar, click More, then select Custom Actions.
• Click + Create.
• In the Create a custom action dialog, search for and select the app you want to use in your action.

The Custom Actions set up wizard has two panels. The left panel is where you chat with Copilot to build your custom action. The right panel is where you test it.

2. Chat with Copilot

Note

A warning at the top of the chat panel reads "Avoid sharing sensitive information, like API keys, passwords, or private data. Copilot isn't designed to store or transmit secrets securely." The warning is always visible and cannot be dismissed. Do not paste credentials into the chat. Use an app connection to authenticate your action instead.

1. In the input box at the bottom of the left side panel, describe the action you want to create.
   • Use plain language. You do not need to use technical language.
2. Click the send icon to submit.

Copilot will then:

• Find the right API endpoints to use.
• Generate the code for the API endpoints.
• Ask follow-up questions, if needed, to clarify what you need.

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.

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.

Edit the description

When Copilot finishes building your action, Zapier generates a name and a description for it. The description appears under the action name in the right panel.

To change the description:

• Click to write your own.
• Click to generate a new one with AI. This is only available after you build your action.

3. Give Copilot feedback (optional)

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

4. 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 automatically saved.

5. Test the action

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

To test your action:

1. In the Authorization section, select an app connection.
   • Learn more about app connections.
2. In the Inputs section, complete all the required fields.
3. Click Run Test.
4. Your Test Results will take a few minutes to load and will provide a detailed log of the API response.
5. Click to expand the:
   • Activity Logs section to review the history of actions taken within your Zapier account. They provide a record of when and how your Zaps have run, including any errors or successes.
   • The Logs section to review logs specific to the test run of your action. They display detailed information about the request and response, including any data sent or received, headers, and status codes.
   • The response logs will censor sensitive information, like API keys or authentication tokens.
6. If you receive an error message indicating the domain or API endpoint is incorrect for the API request, review the troubleshooting guide.

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.

Note

Zapier is aware of a bug where input fields are not always generated. Instead, create an action using API Request actions.

6. Add your action to the Zap editor

Zapier recommends that you test your action before you publish it. If you have not run a test, click Skip test and publish to publish without testing.

1. In the bottom right corner, click Publish. A dialog box will appear.
2. Click either:
   • Back to Library to review all custom actions you have access to.
   • Continue editing to make additional changes to your custom action.

Your custom action will have a descriptive name based on what action it performs. You can now select it as an action event in your Zaps.

Additional resources

• Manage your Custom Actions.
• For further assistance setting up your Custom Actions, visit the Zapier Community's Code and webhook resources.