Create Events
curl --request POST \
--url https://api.example.com/events \
--header 'Content-Type: application/json' \
--data '
[
{
"occurred": "2023-11-07T05:31:56Z",
"event": "<string>",
"resource": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related": [
{}
],
"payload": {},
"follows": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
'import requests
url = "https://api.example.com/events"
payload = [
{
"occurred": "2023-11-07T05:31:56Z",
"event": "<string>",
"resource": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related": [{}],
"payload": {},
"follows": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
occurred: '2023-11-07T05:31:56Z',
event: '<string>',
resource: {},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
related: [{}],
payload: {},
follows: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
])
};
fetch('https://api.example.com/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'occurred' => '2023-11-07T05:31:56Z',
'event' => '<string>',
'resource' => [
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'related' => [
[
]
],
'payload' => [
],
'follows' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/events"
payload := strings.NewReader("[\n {\n \"occurred\": \"2023-11-07T05:31:56Z\",\n \"event\": \"<string>\",\n \"resource\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"related\": [\n {}\n ],\n \"payload\": {},\n \"follows\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/events")
.header("Content-Type", "application/json")
.body("[\n {\n \"occurred\": \"2023-11-07T05:31:56Z\",\n \"event\": \"<string>\",\n \"resource\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"related\": [\n {}\n ],\n \"payload\": {},\n \"follows\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"occurred\": \"2023-11-07T05:31:56Z\",\n \"event\": \"<string>\",\n \"resource\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"related\": [\n {}\n ],\n \"payload\": {},\n \"follows\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Events
Create Events
Record a batch of Events.
For more information, see https://www.prefect.io/docs/v3/concepts/events.
POST
/
events
Create Events
curl --request POST \
--url https://api.example.com/events \
--header 'Content-Type: application/json' \
--data '
[
{
"occurred": "2023-11-07T05:31:56Z",
"event": "<string>",
"resource": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related": [
{}
],
"payload": {},
"follows": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
'import requests
url = "https://api.example.com/events"
payload = [
{
"occurred": "2023-11-07T05:31:56Z",
"event": "<string>",
"resource": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"related": [{}],
"payload": {},
"follows": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
occurred: '2023-11-07T05:31:56Z',
event: '<string>',
resource: {},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
related: [{}],
payload: {},
follows: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
])
};
fetch('https://api.example.com/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'occurred' => '2023-11-07T05:31:56Z',
'event' => '<string>',
'resource' => [
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'related' => [
[
]
],
'payload' => [
],
'follows' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/events"
payload := strings.NewReader("[\n {\n \"occurred\": \"2023-11-07T05:31:56Z\",\n \"event\": \"<string>\",\n \"resource\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"related\": [\n {}\n ],\n \"payload\": {},\n \"follows\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/events")
.header("Content-Type", "application/json")
.body("[\n {\n \"occurred\": \"2023-11-07T05:31:56Z\",\n \"event\": \"<string>\",\n \"resource\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"related\": [\n {}\n ],\n \"payload\": {},\n \"follows\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"occurred\": \"2023-11-07T05:31:56Z\",\n \"event\": \"<string>\",\n \"resource\": {},\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"related\": [\n {}\n ],\n \"payload\": {},\n \"follows\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n]"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Body
application/json
When the event happened from the sender's perspective
The name of the event that happened
The primary Resource this event concerns
Show child attributes
Show child attributes
The client-provided identifier of this event
A list of additional Resources involved in this event
Show child attributes
Show child attributes
An open-ended set of data describing what happened
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.
Response
Successful Response
Was this page helpful?