Post

post

https://api.formant.io/v1/admin/custom-events

Create a new custom event. Resource: events Authorized roles: administrator, device

Body Params

CustomEvent

type

string

enum

severity

string

enum

Allowed:

uuid

createdAt

date-time

updatedAt

date-time

tags

object

organizationId

uuid

ID of the organization in which to create this new event.

externalId

string | null

External ID of this event.

userId

uuid | null

User ID associated with this event.

time

date-time

required

Start time of the data range relevant to this event.

endTime

date-time | null

End time of the data range relevant to this event.

parentId

uuid | null

If this custom event is related to another event, you can add the ID of that parent event here.

metadata

object

User-customizable metadata associated with this event in key-value pair format.

message

string

length ≤ 1024

Message of this event. Must match the message field in the Formant UI when configuring a custom event.

viewed

boolean

deviceId

uuid | null

ID of the device relevant to this event.

streamName

string | null

streamType

string | null

enum

eventTriggerId

uuid | null

notificationEnabled

boolean

Set this to true to enable notifications for this event.

notificationMuted

object | null

Set this to temporarily mute notifications for this event.

deletedAt

date-time | null

Response

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201