Skip to main content
GET
Describe an integration event

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Path Parameters

eventId
string
required

The live event id from GET /v1/integrations/events. Never compose one.

Required string length: 1 - 64
Example:

"k5714pq3vm8x2n6c9d0b7f1h4j6g2r8t"

Response

The live integration event.

eventId
string
required
Minimum string length: 1
provider
string
required
Minimum string length: 1
sourceId
string
required

The connected account this event comes from.

Minimum string length: 1
eventKey
string
required

The provider’s own event name, e.g. created_project.

Minimum string length: 1
title
string
required
Minimum string length: 1
kind
enum<string>
required
Available options:
standard,
custom,
action,
derived,
observed
modelRoles
enum<string>[]
required

This event’s roles in the brand’s product model: signup, activation, conversion, key_event.

Available options:
signup,
activation,
conversion,
key_event
properties
object[]
required
propertiesStatus
enum<string>
required

current: listed with the event or read in the last day. stored: the provider could not be read now; these are its last description. rate_limited: its read budget is spent; these are what Brew stored, possibly none (read again after retryAfterSeconds). unavailable: not read, and none stored.

Available options:
current,
stored,
rate_limited,
unavailable
label
string

Brew’s human name for the event, when it has one.

category
string
stage
enum<string>

The lifecycle stage Brew inferred (a brand member’s correction wins).

Available options:
signup,
activation,
engagement,
conversion,
retention,
churn_risk,
none
volume30d
integer

Occurrences in the last 30 days, as the provider reported.

Required range: x >= 0
lastSeenAt
string<date-time>
triggerEventId
string

Present once the event is a trigger. Otherwise get one with POST /v1/automations/triggers/integration-events.

description
string
derivedFromKey
string

For a derived event: the provider event it is computed from.

retryAfterSeconds
integer

With rate_limited: seconds until the provider can be read again, when it said.