Workflow
curl --request POST \
--url https://api.allium.so/api/v1/streams/data-management/workflows \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"filter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_source_config": {
"topic": "<string>",
"type": "PUBSUB"
},
"data_destination_config": {
"type": "PUBSUB",
"delivery_type": "PULL",
"webhook_url": "<string>"
},
"description": "<string>"
}
'import requests
url = "https://api.allium.so/api/v1/streams/data-management/workflows"
payload = {
"filter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_source_config": {
"topic": "<string>",
"type": "PUBSUB"
},
"data_destination_config": {
"type": "PUBSUB",
"delivery_type": "PULL",
"webhook_url": "<string>"
},
"description": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
data_source_config: {topic: '<string>', type: 'PUBSUB'},
data_destination_config: {type: 'PUBSUB', delivery_type: 'PULL', webhook_url: '<string>'},
description: '<string>'
})
};
fetch('https://api.allium.so/api/v1/streams/data-management/workflows', 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.allium.so/api/v1/streams/data-management/workflows",
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([
'filter_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'data_source_config' => [
'topic' => '<string>',
'type' => 'PUBSUB'
],
'data_destination_config' => [
'type' => 'PUBSUB',
'delivery_type' => 'PULL',
'webhook_url' => '<string>'
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.allium.so/api/v1/streams/data-management/workflows"
payload := strings.NewReader("{\n \"filter_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_source_config\": {\n \"topic\": \"<string>\",\n \"type\": \"PUBSUB\"\n },\n \"data_destination_config\": {\n \"type\": \"PUBSUB\",\n \"delivery_type\": \"PULL\",\n \"webhook_url\": \"<string>\"\n },\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.allium.so/api/v1/streams/data-management/workflows")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_source_config\": {\n \"topic\": \"<string>\",\n \"type\": \"PUBSUB\"\n },\n \"data_destination_config\": {\n \"type\": \"PUBSUB\",\n \"delivery_type\": \"PULL\",\n \"webhook_url\": \"<string>\"\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/streams/data-management/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_source_config\": {\n \"topic\": \"<string>\",\n \"type\": \"PUBSUB\"\n },\n \"data_destination_config\": {\n \"type\": \"PUBSUB\",\n \"delivery_type\": \"PULL\",\n \"webhook_url\": \"<string>\"\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"filter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_source_config": {
"topic": "<string>",
"type": "PUBSUB"
},
"data_destination_config": {
"type": "PUBSUB",
"delivery_type": "PULL",
"webhook_url": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"external_workflow_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Workflows
Create workflow
Create a new workflow by specifying the description, filter, data source, and data destination
POST
/
api
/
v1
/
streams
/
data-management
/
workflows
Workflow
curl --request POST \
--url https://api.allium.so/api/v1/streams/data-management/workflows \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"filter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_source_config": {
"topic": "<string>",
"type": "PUBSUB"
},
"data_destination_config": {
"type": "PUBSUB",
"delivery_type": "PULL",
"webhook_url": "<string>"
},
"description": "<string>"
}
'import requests
url = "https://api.allium.so/api/v1/streams/data-management/workflows"
payload = {
"filter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_source_config": {
"topic": "<string>",
"type": "PUBSUB"
},
"data_destination_config": {
"type": "PUBSUB",
"delivery_type": "PULL",
"webhook_url": "<string>"
},
"description": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filter_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
data_source_config: {topic: '<string>', type: 'PUBSUB'},
data_destination_config: {type: 'PUBSUB', delivery_type: 'PULL', webhook_url: '<string>'},
description: '<string>'
})
};
fetch('https://api.allium.so/api/v1/streams/data-management/workflows', 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.allium.so/api/v1/streams/data-management/workflows",
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([
'filter_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'data_source_config' => [
'topic' => '<string>',
'type' => 'PUBSUB'
],
'data_destination_config' => [
'type' => 'PUBSUB',
'delivery_type' => 'PULL',
'webhook_url' => '<string>'
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.allium.so/api/v1/streams/data-management/workflows"
payload := strings.NewReader("{\n \"filter_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_source_config\": {\n \"topic\": \"<string>\",\n \"type\": \"PUBSUB\"\n },\n \"data_destination_config\": {\n \"type\": \"PUBSUB\",\n \"delivery_type\": \"PULL\",\n \"webhook_url\": \"<string>\"\n },\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.allium.so/api/v1/streams/data-management/workflows")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_source_config\": {\n \"topic\": \"<string>\",\n \"type\": \"PUBSUB\"\n },\n \"data_destination_config\": {\n \"type\": \"PUBSUB\",\n \"delivery_type\": \"PULL\",\n \"webhook_url\": \"<string>\"\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/streams/data-management/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_source_config\": {\n \"topic\": \"<string>\",\n \"type\": \"PUBSUB\"\n },\n \"data_destination_config\": {\n \"type\": \"PUBSUB\",\n \"delivery_type\": \"PULL\",\n \"webhook_url\": \"<string>\"\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"filter_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_source_config": {
"topic": "<string>",
"type": "PUBSUB"
},
"data_destination_config": {
"type": "PUBSUB",
"delivery_type": "PULL",
"webhook_url": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"external_workflow_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint creates a new workflow that connects data sources, filters, and destinations for stream processing.
Supported Values
data_source_config
| Field | Values |
|---|---|
| type | PUBSUB, KAFKA |
data_destination_config
| Field | Values |
|---|---|
| type | PUBSUB, KAFKA |
| delivery_type | PULL, PUSH |
Important Notes
PubSub Topic FormatIn PubSub, a full topic resource name is in the format
projects/{project_id}/topics/{topic_name}.However, for data_source_config, you only need to specify the {topic_name} (e.g., ethereum.transactions).Destination Configuration Requirements
When specifyingdata_destination_config:
- PULL delivery - Only the
typefield is required - PUSH delivery - Both
typeandwebhook_urlfields are required
Authorizations
Body
application/json
- PubSubDataSourceMetadata
- KafkaDataSourceMetadata
Show child attributes
Show child attributes
- PubSubDataDestinationMetadata
- KafkaDataDestinationMetadata
Show child attributes
Show child attributes
Response
Successful Response
- PubSubDataSourceMetadata
- KafkaDataSourceMetadata
Show child attributes
Show child attributes
- PubSubDataDestinationMetadata
- KafkaDataDestinationMetadata
Show child attributes
Show child attributes
Was this page helpful?
⌘I