Status

Every event stream possesses a status. This is either enabled, disabled or paused. Event Streams are managed on an individual basis. A Receiver has the option to interrupt the flow of events from a specific stream by updating the Stream Status.

Status

The status must be retrieved for each stream indivually. Invoke /ssf/status and specify the stream_id.

GETPOSTPATCHPUTDELETE

Fill placeholders

Disable a stream

Disable the stream with the following request.

GETPOSTPATCHPUTDELETE

Fill placeholders

{
  "stream_id": "{STREAM_ID}",
  "status": "disabled"
}

{ "stream_id": "{STREAM_ID}", "status": "disabled" }

Pause a stream

Pause is similar to disable, but in this case events are not nesecceary lost. These may be queued.

GETPOSTPATCHPUTDELETE

Fill placeholders

{
  "stream_id": "{STREAM_ID}",
  "status": "paused"
}

{ "stream_id": "{STREAM_ID}", "status": "paused" }

Enable a stream

Enable the stream using the request provided below.

GETPOSTPATCHPUTDELETE

Fill placeholders

{
  "stream_id": "{STREAM_ID}",
  "status": "enabled"
}

{ "stream_id": "{STREAM_ID}", "status": "enabled" }