npx zapier-sdk create-client-credentials

POST https://zapier.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=YOUR_CLIENT_ID
&client_secret=YOUR_CLIENT_SECRET
&scope=external

{
  "access_token": "eyJ...",
  "token_type": "Bearer",
  "expires_in": 3600
}

POST https://zapier.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=urn:ietf:params:oauth:grant-type:token-exchange
&client_id=ZAPIER_CLIENT_ID
&client_secret=ZAPIER_CLIENT_SECRET
&subject_token=YOUR_JWT
&subject_token_type=urn:ietf:params:oauth:token-type:external-jwt
&requested_token_type=urn:ietf:params:oauth:token-type:access-token
&scope=external

GET https://api.zapier.com/v2/authentications/?app=slack
Authorization: Bearer YOUR_ACCESS_TOKEN

GET https://api.zapier.com/trigger-inbox/api/v1/triggers/?app=slack
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "results": [
    {
      "key": "channel_message",
      "title": "New Message Posted to Channel",
      "description": "Triggers when a new message is posted to a specific #channel you choose.",
      "app_key": "SlackCLIAPI"
    },
    {
      "key": "mention",
      "title": "New Mention",
      "description": "Triggers when a username or highlight word is mentioned in a public #channel.",
      "app_key": "SlackCLIAPI"
    }
  ]
}

GET https://api.zapier.com/trigger-inbox/api/v1/trigger-input-fields/?app=slack&action=channel_message&connection=CONNECTION_ID
Authorization: Bearer YOUR_ACCESS_TOKEN

{
  "results": [
    {
      "key": "channel",
      "title": "Channel",
      "value_type": "STRING",
      "format": "SELECT",
      "is_required": true,
      "description": "Only channels you are a member of will appear in this list."
    },
    {
      "key": "listen_for_bots",
      "title": "Trigger for Bot Messages?",
      "value_type": "BOOLEAN",
      "format": "SELECT",
      "is_required": false,
      "default_value": "no"
    }
  ]
}

PUT https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "app": "slack",
  "action": "channel_message",
  "connection": "CONNECTION_ID",
  "inputs": {
    "channel": "C0123ABC456"
  }
}

{
  "id": "01960a3e-4d5f-7b8e-9c0a-1b2c3d4e5f6a",
  "name": "my-slack-inbox",
  "status": "active",
  "created_at": "2026-05-21T12:00:00.000000Z",
  "paused_reason": null,
  "notification_url": null,
  "subscription": {
    "connection_id": "CONNECTION_ID",
    "app_key": "SlackCLIAPI",
    "action_key": "channel_message",
    "inputs": { "channel": "C0123ABC456" }
  }
}

PUT https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "app": "slack",
  "action": "channel_message",
  "connection": "CONNECTION_ID",
  "inputs": { "channel": "C0123ABC456" },
  "notification_url": "https://your-server.example/trigger-webhook"
}

POST https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/messages/lease/
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "lease_seconds": 30
}

{
  "results": [
    {
      "id": "msg_abc123",
      "created_at": "2026-05-21T12:01:00.000000Z",
      "status": "leased",
      "lease_token": "lt_xyz789",
      "payload": {
        "text": "Hello from Slack",
        "user": "U0123456",
        "channel": "C0123ABC456"
      },
      "message_attributes": {
        "lease_count": 1,
        "error_message": null,
        "possible_duplicate_data": false
      }
    }
  ]
}

POST https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/messages/ack/
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "lease_tokens": ["lt_xyz789"]
}

POST https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/messages/release/
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "lease_tokens": ["lt_xyz789"]
}

GET https://api.zapier.com/trigger-inbox/api/v1/inboxes/
Authorization: Bearer YOUR_ACCESS_TOKEN

POST https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/pause/
Authorization: Bearer YOUR_ACCESS_TOKEN

POST https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/resume/
Authorization: Bearer YOUR_ACCESS_TOKEN

DELETE https://api.zapier.com/trigger-inbox/api/v1/inboxes/my-slack-inbox/
Authorization: Bearer YOUR_ACCESS_TOKEN

import time
import requests

# --- Configuration ---
# Option A (client credentials): obtain via `npx zapier-sdk create-client-credentials`
# Option B (White Label JWT): exchange your partner-signed JWT via POST /oauth/token
ACCESS_TOKEN = "YOUR_BEARER_TOKEN"
CONNECTION_ID = "YOUR_CONNECTION_ID"  # from white label connection flow

BASE_URL = "https://api.zapier.com"
INBOX_NAME = "my-slack-inbox"
HEADERS = {
    "Authorization": f"Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
}

# Step 1: Discover triggers for Slack
resp = requests.get(f"{BASE_URL}/trigger-inbox/api/v1/triggers/?app=slack", headers=HEADERS)
resp.raise_for_status()
triggers = resp.json()["results"]
# triggers[0] == {"key": "channel_message", "title": "New Message Posted to Channel", ...}

# Step 2: Inspect input fields for the chosen trigger.
# Pass connection so Zapier can return dynamic options (e.g. list of channels the user is in).
resp = requests.get(
    f"{BASE_URL}/trigger-inbox/api/v1/trigger-input-fields/",
    params={"app": "slack", "action": "channel_message", "connection": CONNECTION_ID},
    headers=HEADERS,
)
resp.raise_for_status()
# fields[0] == {"key": "channel", "is_required": True, "format": "SELECT", ...}
# In a real UI, present these to the user and collect values.
# Hard-coded here for the example.
CHANNEL_ID = "C0123ABC456"

# Step 3: Create (or reuse) the trigger inbox.
# PUT is an upsert by name — idempotent, safe to call on every startup.
resp = requests.put(
    f"{BASE_URL}/trigger-inbox/api/v1/inboxes/{INBOX_NAME}/",
    json={
        "app": "slack",
        "action": "channel_message",
        "connection": CONNECTION_ID,
        "inputs": {"channel": CHANNEL_ID},
    },
    headers=HEADERS,
)
resp.raise_for_status()
inbox = resp.json()

# Step 4: Wait for the inbox to become active.
# Status starts as "initializing" while Zapier sets up the subscription.
# Do not lease messages until status is "active" — no events are collected yet.
while inbox["status"] == "initializing":
    print("Inbox initializing, waiting...")
    time.sleep(2)
    resp = requests.get(f"{BASE_URL}/trigger-inbox/api/v1/inboxes/{INBOX_NAME}/", headers=HEADERS)
    resp.raise_for_status()
    inbox = resp.json()

if inbox["status"] != "active":
    raise RuntimeError(f"Inbox failed to activate: {inbox['status']} — {inbox.get('paused_reason')}")

print(f"Inbox active: {inbox['id']}")

# Step 5: Poll for messages with exponential backoff.
# In production, run this in a persistent worker process (e.g. under systemd or pm2).
backoff = 5
max_backoff = 60

while True:
    resp = requests.post(
        f"{BASE_URL}/trigger-inbox/api/v1/inboxes/{INBOX_NAME}/messages/lease/",
        # lease_seconds must be longer than your expected processing time.
        # If your process crashes, messages return to the pool after this window.
        json={"lease_seconds": 30},
        headers=HEADERS,
    )
    resp.raise_for_status()
    messages = resp.json().get("results", [])

    if not messages:
        # Back off when inbox is empty to avoid hammering the API.
        time.sleep(backoff)
        backoff = min(backoff * 2, max_backoff)
        continue

    backoff = 5  # reset backoff when messages arrive

    for message in messages:
        lease_token = message["lease_token"]
        attrs = message["message_attributes"]

        # If possible_duplicate_data is True, the upstream app didn't provide a
        # dedup ID. Make your handler idempotent.
        if attrs["possible_duplicate_data"]:
            print(f"Warning: possible duplicate — message {message['id']}")

        try:
            payload = message["payload"]
            print(f"New message in {payload['channel']} from {payload['user']}: {payload['text']}")
            # --- your processing logic here ---

            # Ack removes the message from the inbox permanently.
            requests.post(
                f"{BASE_URL}/trigger-inbox/api/v1/inboxes/{INBOX_NAME}/messages/ack/",
                json={"lease_tokens": [lease_token]},
                headers=HEADERS,
            ).raise_for_status()

        except Exception as exc:
            print(f"Processing failed for {message['id']}: {exc}")
            # After 5 total leases the message is quarantined — ack poison
            # messages before they reach that threshold.
            if attrs["lease_count"] >= 4:
                print(f"Message {message['id']} near quarantine threshold — acking to drop.")
                requests.post(
                    f"{BASE_URL}/trigger-inbox/api/v1/inboxes/{INBOX_NAME}/messages/ack/",
                    json={"lease_tokens": [lease_token]},
                    headers=HEADERS,
                ).raise_for_status()
            else:
                # Release returns the message to the pool immediately rather than
                # waiting for the lease to expire.
                requests.post(
                    f"{BASE_URL}/trigger-inbox/api/v1/inboxes/{INBOX_NAME}/messages/release/",
                    json={"lease_tokens": [lease_token]},
                    headers=HEADERS,
                ).raise_for_status()