Every event type Apigami can send

GET

/events/catalogue

const url = 'https://api.eu.apigami.com/events/catalogue';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.eu.apigami.com/events/catalogue

The types the Apigami API knows, with who receives them and the shape of their data. Public and cacheable for an hour: it is the same list for everyone, and it is what the dashboard’s event picker and the documentation are built from. A new type appears here first.

Responses

200

The catalogue. audience is connected (every active app connected to the user of that browser), app (the one app the event names) or owner (the app’s own team).

application/json

object

types

required

Array<object>

Catalogue entry

object

type

required

string

source

required

What produced it. broker for everything Apigami itself observes.

string

audience

required

Who receives it: every active app connected to the user of that browser, the one app the event names, or the app’s own team.

string

Allowed values: connected app owner

description

required

string

data

required

Field name to type, as documentation — not a JSON Schema.

object

key

additional properties

string

Example

{
  "types": [
    {
      "type": "extension.online",
      "source": "broker",
      "audience": "connected",
      "description": "One of your user's browsers came online",
      "data": {
        "flavor": "string",
        "presence_changed_at": "timestamp",
        "last_seen_at": "timestamp"
      }
    }
  ]
}