The New Item from API trigger in API by Zapier lets you securely call any API: credentials are stored in your connection and never exposed in the Zap. The trigger polls an API endpoint and runs your Zap when new or updated items appear in the response. You configure the request (method, URL, headers, body) and tell Zapier how to find the array of items and which field to use for deduplication.
Prerequisites
- The API endpoint URL you want to poll and, if required, any query params or headers from the API docs.
Note- To use this feature, you'll need to be familiar with sending HTTP requests, APIs, and reading API documentation.
- Zapier Support can help with the API by Zapier action itself but cannot troubleshoot the API you use.
1. Add the trigger
- In the Zap editor, click the Trigger step. A dialog box will appear.
- Search for and select API by Zapier.
- Select the New Item from API trigger event.
- Choose your API by Zapier connection (or create one).
- Click Continue.
API by Zapier steps all display the same app name in your Zap flow. To make it easier to identify which API each step calls, click the step name in the editor and rename it to something descriptive (e.g., "Create Jira Issue" or "Update HubSpot Contact"). You can also add notes to your steps for more context.
2. Configure the request and response
In the Configure tab and complete the fields below.
Method
Select the HTTP method from the dropdown (e.g. GET, POST). Use whatever your API endpoint expects.
URL
Enter the full URL for the request. The URL must match your connection's domain filter (the domain(s) you allowed when you set up the connection).
Query String Parameters (optional)
Add key-value pairs to append to the URL as query parameters. Use this for pagination, filters, or other options your API supports.
Headers (optional)
Add any additional headers the API needs. Authentication headers are added automatically from your connection; only add extra headers (e.g. Accept, custom headers) here.
Body (optional)
Enter the request body when the method requires it (e.g. POST with a JSON body). For JSON, provide valid JSON (e.g. {"key": "value"}). Content-Type will be auto-detected as application/json if the body is a valid JSON object.
Response filter
Enter a path to extract the array of items from the response. Use dot notation, for example:
-
.data— if the array is atresponse.data -
.results.items— if the array is nested atresponse.results.items
Leave empty or use . if the response is already an array. For more advanced filters, refer to the JQ manual.
Dedupe Key
Enter a JQ expression that gives the unique identifier for each item. Zapier uses this to detect new or changed items and only triggers for items with new computed values.
-
Simple field:
.id— use when each item has anid(or similar) field. -
Composite:
.id + "_" + .updated_at— use when you need to combine fields (e.g. id and updated_at) to identify changes.
Only items whose computed value is new will trigger the Zap.
3. Test the trigger
- Click Continue.
- Click Test trigger to run the request and load test records.
- Review the returned items and select a test record if prompted.
- Click Continue with selected record (or Skip test) to finish the step.
If no items appear or you get an error, check that the URL matches your connection's domain filter, that the Response filter and Dedupe Key match your API's response shape, and that your connection's auth is valid.