event.subscribe
curl --request POST \
--url http://127.0.0.1:8081/v1/rpc/event.subscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"jsonrpc": "2.0",
"method": "event.subscribe",
"id": "<string>",
"params": {
"filter": {
"entity_id": "<string>",
"event_name": "<string>",
"has_dead_letter": true,
"reason_code": "<string>",
"run_id": "<string>",
"subscriber_id": "<string>"
},
"replay_since": "2023-11-07T05:31:56Z"
}
}
'import requests
url = "http://127.0.0.1:8081/v1/rpc/event.subscribe"
payload = {
"jsonrpc": "2.0",
"method": "event.subscribe",
"id": "<string>",
"params": {
"filter": {
"entity_id": "<string>",
"event_name": "<string>",
"has_dead_letter": True,
"reason_code": "<string>",
"run_id": "<string>",
"subscriber_id": "<string>"
},
"replay_since": "2023-11-07T05:31:56Z"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jsonrpc: '2.0',
method: 'event.subscribe',
id: '<string>',
params: {
filter: {
entity_id: '<string>',
event_name: '<string>',
has_dead_letter: true,
reason_code: '<string>',
run_id: '<string>',
subscriber_id: '<string>'
},
replay_since: '2023-11-07T05:31:56Z'
}
})
};
fetch('http://127.0.0.1:8081/v1/rpc/event.subscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8081",
CURLOPT_URL => "http://127.0.0.1:8081/v1/rpc/event.subscribe",
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([
'jsonrpc' => '2.0',
'method' => 'event.subscribe',
'id' => '<string>',
'params' => [
'filter' => [
'entity_id' => '<string>',
'event_name' => '<string>',
'has_dead_letter' => true,
'reason_code' => '<string>',
'run_id' => '<string>',
'subscriber_id' => '<string>'
],
'replay_since' => '2023-11-07T05:31:56Z'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://127.0.0.1:8081/v1/rpc/event.subscribe"
payload := strings.NewReader("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"event.subscribe\",\n \"id\": \"<string>\",\n \"params\": {\n \"filter\": {\n \"entity_id\": \"<string>\",\n \"event_name\": \"<string>\",\n \"has_dead_letter\": true,\n \"reason_code\": \"<string>\",\n \"run_id\": \"<string>\",\n \"subscriber_id\": \"<string>\"\n },\n \"replay_since\": \"2023-11-07T05:31:56Z\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://127.0.0.1:8081/v1/rpc/event.subscribe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"event.subscribe\",\n \"id\": \"<string>\",\n \"params\": {\n \"filter\": {\n \"entity_id\": \"<string>\",\n \"event_name\": \"<string>\",\n \"has_dead_letter\": true,\n \"reason_code\": \"<string>\",\n \"run_id\": \"<string>\",\n \"subscriber_id\": \"<string>\"\n },\n \"replay_since\": \"2023-11-07T05:31:56Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8081/v1/rpc/event.subscribe")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"event.subscribe\",\n \"id\": \"<string>\",\n \"params\": {\n \"filter\": {\n \"entity_id\": \"<string>\",\n \"event_name\": \"<string>\",\n \"has_dead_letter\": true,\n \"reason_code\": \"<string>\",\n \"run_id\": \"<string>\",\n \"subscriber_id\": \"<string>\"\n },\n \"replay_since\": \"2023-11-07T05:31:56Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"jsonrpc": "2.0",
"id": "<string>",
"result": {
"subscription_id": "<string>"
}
}Events
event.subscribe
Live event stream with the same filter shape as event.list. Filter
parity is required by the conventions section. Pagination params
(limit, cursor) and the time-window until are NOT accepted here
— subscriptions deliver everything matching the filter live.
Transport: all methods are a single POST /v1/rpc with the method name in the JSON-RPC body. The path shown is a per-method convenience.
POST
/
v1
/
rpc
/
event.subscribe
event.subscribe
curl --request POST \
--url http://127.0.0.1:8081/v1/rpc/event.subscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"jsonrpc": "2.0",
"method": "event.subscribe",
"id": "<string>",
"params": {
"filter": {
"entity_id": "<string>",
"event_name": "<string>",
"has_dead_letter": true,
"reason_code": "<string>",
"run_id": "<string>",
"subscriber_id": "<string>"
},
"replay_since": "2023-11-07T05:31:56Z"
}
}
'import requests
url = "http://127.0.0.1:8081/v1/rpc/event.subscribe"
payload = {
"jsonrpc": "2.0",
"method": "event.subscribe",
"id": "<string>",
"params": {
"filter": {
"entity_id": "<string>",
"event_name": "<string>",
"has_dead_letter": True,
"reason_code": "<string>",
"run_id": "<string>",
"subscriber_id": "<string>"
},
"replay_since": "2023-11-07T05:31:56Z"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
jsonrpc: '2.0',
method: 'event.subscribe',
id: '<string>',
params: {
filter: {
entity_id: '<string>',
event_name: '<string>',
has_dead_letter: true,
reason_code: '<string>',
run_id: '<string>',
subscriber_id: '<string>'
},
replay_since: '2023-11-07T05:31:56Z'
}
})
};
fetch('http://127.0.0.1:8081/v1/rpc/event.subscribe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8081",
CURLOPT_URL => "http://127.0.0.1:8081/v1/rpc/event.subscribe",
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([
'jsonrpc' => '2.0',
'method' => 'event.subscribe',
'id' => '<string>',
'params' => [
'filter' => [
'entity_id' => '<string>',
'event_name' => '<string>',
'has_dead_letter' => true,
'reason_code' => '<string>',
'run_id' => '<string>',
'subscriber_id' => '<string>'
],
'replay_since' => '2023-11-07T05:31:56Z'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://127.0.0.1:8081/v1/rpc/event.subscribe"
payload := strings.NewReader("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"event.subscribe\",\n \"id\": \"<string>\",\n \"params\": {\n \"filter\": {\n \"entity_id\": \"<string>\",\n \"event_name\": \"<string>\",\n \"has_dead_letter\": true,\n \"reason_code\": \"<string>\",\n \"run_id\": \"<string>\",\n \"subscriber_id\": \"<string>\"\n },\n \"replay_since\": \"2023-11-07T05:31:56Z\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://127.0.0.1:8081/v1/rpc/event.subscribe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"jsonrpc\": \"2.0\",\n \"method\": \"event.subscribe\",\n \"id\": \"<string>\",\n \"params\": {\n \"filter\": {\n \"entity_id\": \"<string>\",\n \"event_name\": \"<string>\",\n \"has_dead_letter\": true,\n \"reason_code\": \"<string>\",\n \"run_id\": \"<string>\",\n \"subscriber_id\": \"<string>\"\n },\n \"replay_since\": \"2023-11-07T05:31:56Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8081/v1/rpc/event.subscribe")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"jsonrpc\": \"2.0\",\n \"method\": \"event.subscribe\",\n \"id\": \"<string>\",\n \"params\": {\n \"filter\": {\n \"entity_id\": \"<string>\",\n \"event_name\": \"<string>\",\n \"has_dead_letter\": true,\n \"reason_code\": \"<string>\",\n \"run_id\": \"<string>\",\n \"subscriber_id\": \"<string>\"\n },\n \"replay_since\": \"2023-11-07T05:31:56Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"jsonrpc": "2.0",
"id": "<string>",
"result": {
"subscription_id": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json

