Sign in

v1

latestOpenAPI 3.1.02026-07-24223580832.9 KB
target

Partially Update a Target

Update some fields of a target using its ID. Include only the fields to be changed in the request body.

patch/streaming/v2/targets/{id}

Path parameters

idstring uuid required

ID of target to fetch

Request body

namestring

New name for the target

descriptionstring

Optional updated description of the target

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

Updated status of the target

type'webhook' | 'websocket'

The type of target to update. If changed, settings should match the new type

max_buffer_countinteger

Maximum number of events that can be buffered before delivery

Response

Target updated

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