Event API

Overview

Event also allows you to emit and transact on messages using the Event API.

Generate an Event API Key

Head over to the Secret Keys section in the Settings page:

Click the + Create secret key button
Name your Secret Key
Click Create

Ensure you store the test and live keys somewhere safe (like a password manager).

Authentication

To authenticate and use any of the below API endpoints, you'll need to pass an Event Secret Key in the headers.

Header

Value

API Endpoints

GET

Emit a custom event

POSThttps://events.buildable.dev/emit

Body

event*string

Example: ""

payload*object

Response

Emit Response

Body

object

Request

const response = await fetch('https://events.buildable.dev/emit', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "event": "",
      "payload": {}
    }),
});
const data = await response.json();

Response

{
  "status": "success",
  "key": "2b4bc1689000424287d1e68e6e8cf3d1"
}

Get the full event name

POSThttps://events.buildable.dev/get-full-event-name

Body

eventName*string

Example: ""

platformstring

Example: ""

labelstring

Example: ""

Response

Get Full Event Name Response

Body

fullNamestring

Request

const response = await fetch('https://events.buildable.dev/get-full-event-name', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventName": ""
    }),
});
const data = await response.json();