Skip to content
Get Started

Public API

Event log

On this page

Events recorded for one app and environment.

These routes are the public API. Send Authorization: Bearer with a workspace server API key. The key can act on every app in the workspace. A route that names an app uses that app id. environment is development or production.

GET /api/v1/public/apps/{app}/environments/{environment}/events

The events were listed.

Path

  • app — App id in this workspace.
  • environment — development or production.

Query

  • search (string)
  • name (string)
  • subscriber (uuid)
  • page (integer)
  • per_page (10, 25, 50)

Responses

  • 200 EVENTS_LISTED — The events were listed.
    • page (integer, required)
    • per_page (integer, required)
    • total (integer, required)
  • 401 INVALID_API_KEY — The API key is invalid.
  • 404 APP_NOT_FOUND — The app could not be found.
  • 422 VALIDATION_FAILED — The request contains invalid fields.
  • 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
  • 500 SERVER_ERROR — Something went wrong. Please try again.

POST /api/v1/public/apps/{app}/environments/{environment}/events

The event was recorded.

Path

  • app — App id in this workspace.
  • environment — development or production.

Body

  • name (string, required) — Event name, such as order.shipped. At most 80 characters.
  • subscriber_id (uuid, required) — Subscriber id returned by save.
  • properties (array of string, optional) — Optional object of properties. At most 20 keys. A value is text, a number, a boolean, or null.

Responses

  • 201 EVENT_RECORDED — The event was recorded.
    • id (string, required)
    • name (string, required)
    • subscriber_id (string, required)
  • 401 INVALID_API_KEY — The API key is invalid.
  • 404 SUBSCRIBER_NOT_FOUND — The subscriber could not be found.
  • 422 VALIDATION_FAILED — The request contains invalid fields.
  • 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
  • 500 SERVER_ERROR — Something went wrong. Please try again.

POST /api/v1/public/apps/{app}/environments/{environment}/events/bulk

The events were deleted.

Path

  • app — App id in this workspace.
  • environment — development or production.

Body

  • ids (array of uuid, required)

Responses

  • 200 EVENTS_DELETED — The events were deleted.
  • 401 INVALID_API_KEY — The API key is invalid.
  • 404 APP_NOT_FOUND — The app could not be found.
  • 422 VALIDATION_FAILED — The request contains invalid fields.
  • 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
  • 500 SERVER_ERROR — Something went wrong. Please try again.

GET /api/v1/public/apps/{app}/environments/{environment}/events/{event}

The event was found.

Path

  • app — App id in this workspace.
  • environment — development or production.
  • event — Event id.

Responses

  • 200 EVENT_FETCHED — The event was found.
    • id (string, required)
    • name (string, required)
    • subscriber_id (string, required)
    • properties (object, required)
  • 401 INVALID_API_KEY — The API key is invalid.
  • 404 RESOURCE_NOT_FOUND — The requested resource could not be found.
  • 429 RATE_LIMIT_EXCEEDED — Too many requests. Please try again later.
  • 500 SERVER_ERROR — Something went wrong. Please try again.