Skip to content

Create signal

POST
/signals

Create a new feedback signal. Signals can be comments or ratings, and can optionally be linked to pipeline executions.

object
teamId
required

ID of the team that will own this signal

string
data
required
One of:
object
type
required

Signal type identifier

string
Allowed values: comment
text
required

The comment text content

string
>= 1 characters
executionIds

Optional array of pipeline execution IDs to link this signal to

Array<string>

Signal created successfully

object
signalId
required

Unique identifier for the signal (nanoid format)

string
teamId
required

ID of the team that owns this signal

string
dataType
required

Type of signal data

string
Allowed values: comment rating evaluation
data
required
One of:
object
type
required

Signal type identifier

string
Allowed values: comment
text
required

The comment text content

string
>= 1 characters
executionIds
required

IDs of pipeline executions this signal is linked to

Array<string>
createdAt
required

ISO 8601 timestamp when the signal was created

string format: date-time

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean