Skip to main content
GET /v1/integrations returns the triggerable integration-event catalog for your brand. It lists every event you can build automations from — even for providers you haven’t connected yet — so an agent can see what’s possible before wiring anything. Requires the automations scope. For each provider you get connected (an active connection exists) and, per event, provisioned (a Brew trigger already exists for it), plus the fieldKeys / requiredFieldKeys that event carries.

List the catalog

curl -G "https://brew.new/api/v1/integrations" \
  -H "Authorization: Bearer $BREW_API_KEY"
Scope to a single provider with ?provider= (clerk | stripe | stytch | supabase | workos | shopify | revenuecat). An unknown provider is a 400 INVALID_REQUEST.
const { integrations } = await brew.integrations.list({ provider: 'stripe' })

From discovery to a live automation

  1. Pick an eventType from the catalog (e.g. user.created).
  2. Connect the provider in the dashboard if connected is false — connecting provisions a Brew trigger for every supported event automatically.
  3. Build + publish an automation wired to that trigger. A trigger only fires when at least one automation referencing it is published.
  4. Fire it (or let the provider’s webhook fire it). The trigger-fire API:
const result = await brew.automationRuns.fire({
  triggerEventId: 'tri_user_created',
  payload: { email: 'jane@example.com', firstName: 'Jane' },
  idempotencyKey: `signup-${userId}`,
})
console.log(result.details?.automationRunIds)

See also

Need Help?

Our team is ready to support you at every step of your journey with Brew. Choose the option that works best for you:

Search Documentation

Type in the “Ask any question” search bar at the top left to instantly find relevant documentation pages.

ChatGPT/Claude Integration

Click “Open in ChatGPT” at the top right of any page to analyze documentation with ChatGPT or Claude for deeper insights.