Event Types API

Discover and manage the event types tracked in your Organizational Unit. Event types represent the different actions leads can take, such as page_view, email_open, or form_submit.

GET /event-types

List all visible event type names for the active Organizational Unit. Hidden event types are excluded from this response.

Request

No query parameters required.

Response

200 OK

["page_view", "signup", "email_open", "demo_request"]

Returns a JSON array of event type name strings.

Example

curl -X GET "https://api.leadvibe.com/event-types" \
  -H "Authorization: Bearer <token>"

Common Errors

Status	Meaning	Solution
401	Unauthorized	Check authentication credentials

---

GET /event-types/{eventType}/properties

List the distinct metadata property keys that have been observed for a specific event type within the active OU. Useful for building dynamic filter UIs or understanding what data is being captured.

Request

Parameter	Type	Required	Description
eventType	string	Yes	Event type name (path parameter)

Response

200 OK

{
  "event_type": "page_view",
  "properties": ["path", "utm_source", "campaign", "referrer"]
}

Response Fields

Field	Type	Description
event_type	string	The event type queried
properties	array	List of distinct metadata property keys observed

Example

curl -X GET "https://api.leadvibe.com/event-types/page_view/properties" \
  -H "Authorization: Bearer <token>"

Common Errors

Status	Meaning	Solution
401	Unauthorized	Check authentication credentials
404	Not Found	Event type does not exist in this OU

---

Event Type Settings

These endpoints manage event type visibility and deletion within your Organizational Unit.

GET /settings/ou/event-types

List all event types with visibility status, event counts, and deletion eligibility for the active OU.

Response

200 OK

[
  {
    "name": "page_view",
    "hidden": false,
    "ou_event_count": 14520,
    "protected": true,
    "deletable": false
  },
  {
    "name": "test_event",
    "hidden": true,
    "ou_event_count": 3,
    "protected": false,
    "deletable": true
  }
]

Response Fields

Field	Type	Description
name	string	Event type name
hidden	boolean	Whether this event type is hidden from lists and dropdowns
ou_event_count	integer	Number of events of this type in the active OU
protected	boolean	Whether this event type is used by scoring rules or triggers
deletable	boolean	Whether all events of this type can be deleted

Example

curl -X GET "https://api.leadvibe.com/settings/ou/event-types" \
  -H "Authorization: Bearer <token>"

---

PUT /settings/ou/event-types/{eventType}

Show or hide an event type in the active OU. Hiding an event type removes it from dropdowns and lists but preserves all data.

Request

Parameter	Type	Required	Description
eventType	string	Yes	Event type name (path parameter)

Request Body

Field	Type	Required	Description
hidden	boolean	Yes	Set to true to hide, false to show

{
  "hidden": true
}

Response

204 No Content

Example

curl -X PUT "https://api.leadvibe.com/settings/ou/event-types/test_event" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"hidden": true}'

---

GET /settings/ou/event-types/{eventType}/dry-run-delete

Preview the impact of deleting all events of a given type. Use this before performing the actual deletion to understand what will be affected.

Request

Parameter	Type	Required	Description
eventType	string	Yes	Event type name (path parameter)

Response

200 OK

{
  "events_count": 142,
  "event_scores_count": 89
}

Response Fields

Field	Type	Description
events_count	integer	Number of events that would be deleted
event_scores_count	integer	Number of associated score records that would be affected

Example

curl -X GET "https://api.leadvibe.com/settings/ou/event-types/test_event/dry-run-delete" \
  -H "Authorization: Bearer <token>"

---

DELETE /settings/ou/event-types/{eventType}/events

Delete all events of a specific event type in the active OU. This action is irreversible.

Request

Parameter	Type	Required	Description
eventType	string	Yes	Event type name (path parameter)

Response

200 OK

Returns a summary of the deletion.

Example

curl -X DELETE "https://api.leadvibe.com/settings/ou/event-types/test_event/events" \
  -H "Authorization: Bearer <token>"

Common Errors

Status	Meaning	Solution
401	Unauthorized	Check authentication credentials

---

Notes

• Event types are OU-scoped to the active Organizational Unit
• Hiding an event type is reversible and preserves all data -- use it to declutter dropdowns
• Deleting events is irreversible and removes event data, but does not delete leads or accounts
• Protected event types (used by scoring rules or triggers) cannot be deleted until those rules are removed
• Use the dry-run endpoint before deleting to understand the impact

Related Endpoints

• Events - List and manage events
• Scoring Rules - Rules that reference event types