Events
Create Events
Record a batch of Events
POST
/
api
/
events
Headers
x-prefect-api-version
string
Body
application/json · object[]
occurred
string
requiredWhen the event happened from the sender's perspective
event
string
requiredThe name of the event that happened
resource
object
requiredThe primary Resource this event concerns
related
object[]
A list of additional Resources involved in this event
payload
object
An open-ended set of data describing what happened
id
string
requiredThe client-provided identifier of this event
follows
string | null
The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order.
Was this page helpful?