Skip to main content
POST
Create a new notification settings

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
eventType
enum<string>
required
Available options:
workflow_started,
workflow_finished,
workflow_failed,
workflow_sample_finished,
workflow_data_change,
system_maintenance,
service_degradation,
credits_low,
free_trial_ending
eventConfiguration
object
required

Settings specific to the event type. Currently accepts an empty object {}. This object will be extended in future releases to support event-specific configuration options.

workflowId
string

Workflow ID (optional, if not provided creates workspace-level settings)

enabled
boolean
default:true
channelIds
string[]

Array of channel IDs to link to this Settings

Response

Settings created successfully

data
object
status
string
message
string