Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
target

Create a Target

Creates a new target. Duplicate targets are not allowed.

post/streaming/v2/targets

Request body

namestring required

The name of the target

descriptionstring

Optional information about the target

status'disconnected' | 'active' | 'failed'

Current status of the target

type'webhook' | 'websocket' required

The type of target, indicating the communication protocol.

max_buffer_countinteger

Maximum number of events that can be buffered before delivery.

Response

Target created

idstring uuid required
namestring required
descriptionstring
status'disconnected' | 'active' | 'connected' | 'failed' required
type'webhook' | 'websocket' required
created_atstring date-time
updated_atstring date-time
max_buffer_countinteger required

Maximum number of events that can be buffered before delivery.

current_buffer_countinteger required