What is the Trigger Inbox API?
The Trigger Inbox API lets you receive and process events from apps connected to Zapier. Instead of setting up webhooks or building your own polling system for each app, you create an inbox that subscribes to trigger events, and the API delivers messages to you. The queue model follows the same pull-based, at-least-once delivery pattern as Amazon SQS. Your backend pulls (leases) messages on its own schedule, processes them, and acknowledges (deletes) them. If you have used SQS, the concepts map closely.Key benefits
- One API for all apps: Gmail, Slack, GitHub, Google Calendar, and 9,000+ apps.
- Managed authentication: Zapier handles OAuth flows and token refresh.
- Reliable delivery: Messages are queued and can be retried.
- Standard format: Consistent message structure across all apps.
- No inbound endpoints: Your backend pulls messages on its own schedule. You do not need to expose a public webhook endpoint to receive events.
- Concurrency-safe: Designed to be consumed by multiple processes, with built-in leasing and acknowledgment modeled on SQS.
Core concepts
| Concept | What it is |
|---|---|
| Inbox | A named queue that collects events from a connected app. You configure it with an app, trigger type (action_key), and any input filters (for example, a specific Slack channel). You can have multiple inboxes, each subscribed to a different app’s trigger (for example, one for new Slack messages and another for new Gmail emails). |
| Message | An event delivered to your inbox. Each message includes the event payload (the raw data from the app) and metadata such as lease count and delivery status. |
| Lease | A temporary lock on a message that gives your app exclusive access for a set duration. Other consumers cannot claim the message while it is leased. |
| Acknowledge | Confirmation that you have successfully processed a message. Acknowledging permanently removes it from the inbox. If you do not acknowledge within the lease duration, the message returns to the queue for retry. |
How it works
- Create an inbox. Subscribe to a trigger (for example, Gmail “new email”).
- Event occurs. A user receives an email; Gmail fires the trigger.
- Message queued. Zapier captures the event and adds it to your inbox.
- Lease available messages. Your app requests a batch of messages for exclusive processing.
- Process. Read the payload and run your business logic.
- Acknowledge. Confirm success; the message is permanently removed.
notification_url, Zapier also sends a POST to your server when new messages arrive, so you can lease on demand instead of polling continuously.
The Trigger Inbox API uses an at-least-once delivery model, the same guarantee Amazon SQS provides:
- Messages are delivered at least once (possibly more if retries occur).
- You must implement idempotent processing (safe to process duplicates).
- Messages not acknowledged within the lease duration return to the queue.
- Messages that are leased 5 times without being acknowledged are quarantined.
Architecture
Inbox states
An inbox transitions through these states:- Initializing: Subscription is being set up.
- Active: Receiving events and queueing messages.
- Paused: Collection stopped. Buffered messages are preserved. Check the
paused_reasonfield for detail. Resuming a paused inbox goes back throughinitializing. - Deleting: Being torn down asynchronously (takes several hours to complete).
- Initialization failure: Setup failed. Check
paused_reasonfor detail. You cannot resume from this state. Delete the inbox and create a new one.
Message lifecycle
Messages flow through these states:- Available: Ready to be leased.
- Leased: Locked by a consumer for a set duration.
- Acknowledged: Permanently removed.
- Expired: Lease timed out; message returns to available.
- Quarantined: Leased and released 5 times without acknowledgment. No longer returned by lease calls, but visible in list calls for inspection.
When to use the Trigger Inbox API
The Trigger Inbox API is a good fit when you need programmatic, backend access to events from multiple apps, without building per-app webhook integrations, polling infrastructure, or exposing public endpoints. Use it if you are:- Processing events from multiple apps (Gmail, Slack, GitHub) through a single API
- Building data pipelines or internal tools that consume events programmatically
- Working in infrastructure that cannot expose public webhook endpoints
- Decoupling event capture from processing, or batching events before acting on them
Comparison to Powered by Zapier
If you want end users to build their own workflows, Powered by Zapier is the better fit. The two approaches serve different audiences:| Trigger Inbox API | Powered by Zapier | |
|---|---|---|
| Built for | Developers building backend systems. | End users creating their own workflows. |
| Branding | Your UI, no Zapier branding visible. | Zapier-branded UI embedded in your product. |
| Control | Full control over UX and processing logic. | Pre-built Zapier experience. |
| Scope | Receive trigger events only. | Full workflow creation (triggers and actions). |
Security and authentication
The Trigger Inbox API uses OAuth 2.0 bearer tokens for authentication. All API requests must include anAuthorization: Bearer YOUR_ACCESS_TOKEN header.
Two authentication methods are available:
- SDK client credentials: Quick setup for local testing.
- JWT authentication: Production-ready with user-specific tokens.
Limits
| Limit | Value |
|---|---|
| Token expiration | 10 hours |
| Inbox initialization time | Variable |
| Message delivery time | Seconds to ~5 minutes (variable, depends on the connected app) |
| Default lease duration | 5 minutes |
| Maximum lease duration | 60 minutes |
| Default messages per lease | 10 |
| Maximum messages per lease | 100 |
| Quarantine threshold | 5 failed leases |
| Inbox operations rate limit | 1,000 per hour |
| Message operations rate limit | 1,000 per minute |
Next steps
- Trigger Inbox onboarding: the fastest way to understand the message queue model, no external app connection required.
- Create a trigger inbox for an app: connect to Slack, Gmail, and 9,000+ other apps.
- Manage your inbox.
- Trigger Inbox API reference.