ANansible
event-streams

PATCH /event-streams/{id}/

Changed on

Request

  • Base URL
    /api/eda/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/eda/v1/event-streams/{id}/
  • Auth
    • API key in cookie sessionid
    • or HTTP basic
    • or HTTP bearer
    • or API key in header X-DAB-JW-TOKEN

Path parameters

idinteger required

A unique integer value identifying this event stream.

Request body

namestring

The name of the webhook

test_modeboolean

Enable test mode

additional_data_headersstring

The additional http headers which will be added to the event data. The headers are comma delimited

eda_credential_idinteger
organization_idinteger nullable
event_stream_typestring

The type of the event stream based on credential type

Response

Update successful, return the new event stream.

namestring required

The name of the webhook

test_modeboolean

Enable test mode

additional_data_headersstring

The additional http headers which will be added to the event data. The headers are comma delimited

organizationstring required
event_stream_typestring

The type of the event stream based on credential type

idinteger required
ownerstring required
urlstring required

The URL which will be used to post to the event stream

created_atstring date-time required
modified_atstring date-time required
test_content_typestring required

The content type of test data, when in test mode

test_contentstring required

The content recieved, when in test mode, stored as a yaml string

test_error_messagestring required

The error message, when in test mode

test_headersstring required

The headers recieved, when in test mode, stored as a yaml string

events_receivedinteger required

The total number of events received by event stream

last_event_received_atstring date-time nullable required

The date/time when the last event was received

Changes