Create an event stream

curl --request POST \
  --url https://api.extole.io/v6/event-streams \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "description": "description",
  "name": "name",
  "stop_at": "2025-10-24T09:00:00.000Z",
  "tags": [
    "tag"
  ]
}
'

import requests

url = "https://api.extole.io/v6/event-streams"

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "description": "description",
    "name": "name",
    "stop_at": "2025-10-24T09:00:00.000Z",
    "tags": ["tag"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    description: 'description',
    name: 'name',
    stop_at: '2025-10-24T09:00:00.000Z',
    tags: ['tag']
  })
};

fetch('https://api.extole.io/v6/event-streams', 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.extole.io/v6/event-streams",
  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([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'description' => 'description',
    'name' => 'name',
    'stop_at' => '2025-10-24T09:00:00.000Z',
    'tags' => [
        'tag'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.extole.io/v6/event-streams"

	payload := strings.NewReader("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"description\": \"description\",\n  \"name\": \"name\",\n  \"stop_at\": \"2025-10-24T09:00:00.000Z\",\n  \"tags\": [\n    \"tag\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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.extole.io/v6/event-streams")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"description\": \"description\",\n  \"name\": \"name\",\n  \"stop_at\": \"2025-10-24T09:00:00.000Z\",\n  \"tags\": [\n    \"tag\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/event-streams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"description\": \"description\",\n  \"name\": \"name\",\n  \"stop_at\": \"2025-10-24T09:00:00.000Z\",\n  \"tags\": [\n    \"tag\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "created_date": "2025-10-24T09:00:00.000Z",
  "description": "<string>",
  "filters": [
    {
      "id": "<string>",
      "type": "APPLICATION_TYPE",
      "app_types": [
        "<string>"
      ]
    }
  ],
  "id": "<string>",
  "name": "<string>",
  "stop_at": "2025-10-24T09:00:00.000Z",
  "tags": [
    "<string>"
  ],
  "updated_date": "2025-10-24T09:00:00.000Z"
}

POST

event-streams

Create an event stream

curl --request POST \
  --url https://api.extole.io/v6/event-streams \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "component_ids": [
    "component_id"
  ],
  "component_references": [
    {
      "component_id": "component_id",
      "socket_names": [
        "socket_name"
      ]
    }
  ],
  "description": "description",
  "name": "name",
  "stop_at": "2025-10-24T09:00:00.000Z",
  "tags": [
    "tag"
  ]
}
'

import requests

url = "https://api.extole.io/v6/event-streams"

payload = {
    "component_ids": ["component_id"],
    "component_references": [
        {
            "component_id": "component_id",
            "socket_names": ["socket_name"]
        }
    ],
    "description": "description",
    "name": "name",
    "stop_at": "2025-10-24T09:00:00.000Z",
    "tags": ["tag"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    component_ids: ['component_id'],
    component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
    description: 'description',
    name: 'name',
    stop_at: '2025-10-24T09:00:00.000Z',
    tags: ['tag']
  })
};

fetch('https://api.extole.io/v6/event-streams', 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.extole.io/v6/event-streams",
  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([
    'component_ids' => [
        'component_id'
    ],
    'component_references' => [
        [
                'component_id' => 'component_id',
                'socket_names' => [
                                'socket_name'
                ]
        ]
    ],
    'description' => 'description',
    'name' => 'name',
    'stop_at' => '2025-10-24T09:00:00.000Z',
    'tags' => [
        'tag'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.extole.io/v6/event-streams"

	payload := strings.NewReader("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"description\": \"description\",\n  \"name\": \"name\",\n  \"stop_at\": \"2025-10-24T09:00:00.000Z\",\n  \"tags\": [\n    \"tag\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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.extole.io/v6/event-streams")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"description\": \"description\",\n  \"name\": \"name\",\n  \"stop_at\": \"2025-10-24T09:00:00.000Z\",\n  \"tags\": [\n    \"tag\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v6/event-streams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_ids\": [\n    \"component_id\"\n  ],\n  \"component_references\": [\n    {\n      \"component_id\": \"component_id\",\n      \"socket_names\": [\n        \"socket_name\"\n      ]\n    }\n  ],\n  \"description\": \"description\",\n  \"name\": \"name\",\n  \"stop_at\": \"2025-10-24T09:00:00.000Z\",\n  \"tags\": [\n    \"tag\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "component_ids": [
    "<string>"
  ],
  "created_date": "2025-10-24T09:00:00.000Z",
  "description": "<string>",
  "filters": [
    {
      "id": "<string>",
      "type": "APPLICATION_TYPE",
      "app_types": [
        "<string>"
      ]
    }
  ],
  "id": "<string>",
  "name": "<string>",
  "stop_at": "2025-10-24T09:00:00.000Z",
  "tags": [
    "<string>"
  ],
  "updated_date": "2025-10-24T09:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Body

application/json

Body of a POST /v6/event-streams request.

name

required

Choose between static or dynamic name

component_ids

string[]

component_references

object[]

Show child attributes

description

Choose between static or dynamic description

stop_at

string

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$

Example:

"2025-10-24T09:00:00.000Z"

Response

Successful response

Stored event stream definition. Fields name and description are unevaluated and appear in buildtime-evaluatable form.

component_ids

string[]

required

created_date

string

required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$

Example:

"2025-10-24T09:00:00.000Z"

description

required

The description as configured: a literal value, or an expression (type:string) when defined dynamically.

filters

(APPLICATION_TYPE · object | EVENT_NAME · object | EVENT_TYPE · object | PERSON_ID · object | SANDBOX · object)[]

required

APPLICATION_TYPE
EVENT_NAME
EVENT_TYPE
PERSON_ID
SANDBOX

Show child attributes

string

required

read-only

name

required

The name as configured: a literal value, or an expression (type:string) when defined dynamically.

stop_at

string

required

RFC 3339 UTC date-time with a Z suffix. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$

Example:

"2025-10-24T09:00:00.000Z"

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Create an event stream

Authorizations

Body

Response