Skip to main content
POST
Create broadcastEvent resource

Authorizations

X-API-KEY
string
header
required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

broadcastId
string<objectId>
required

Resource identifier.

broadcastClientId
string<objectId>
required

Resource identifier.

Body

application/json
type
enum<string>
required
Available options:
app.opened
Example:

"app.opened"

occurredAt
unknown
payload
unknown
metadata
object

Response

201 - application/json

Success

type
enum<string>
required
Available options:
app.opened
Example:

"app.opened"

_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

occurredAt
unknown
payload
unknown
metadata
object
_updatedAt
string<date-time> | null
Example:

"2024-01-01T00:00:00.000Z"

_reference
string | null
Example:

"string"