Skip to main content
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>"
}
'
{
  "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>"
}
This endpoint creates a new workflow that connects data sources, filters, and destinations for stream processing.

​
Supported Values

​
data_source_config

FieldValues
typePUBSUB, KAFKA

​
data_destination_config

FieldValues
typePUBSUB, KAFKA
delivery_typePULL, 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 specifying data_destination_config:
  • PULL delivery - Only the type field is required
  • PUSH delivery - Both type and webhook_url fields are required

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
filter_id
string<uuid>
required
​
data_source_config
PubSubDataSourceMetadata · object
required
​
data_destination_config
PubSubDataDestinationMetadata · object
required
​
description
string | null

Response

Successful Response

​
filter_id
string<uuid>
required
​
data_source_config
PubSubDataSourceMetadata · object
required
​
data_destination_config
PubSubDataDestinationMetadata · object
required
​
id
string<uuid> | null
​
description
string | null
​
external_workflow_id
string | null