Engine

Covers Engine 2.0.0

argus/update-event-status

Updates event status.

  • Category: Events

Request payload

FieldTypeRequirementDescription
event_idstringOptionalStable event ID. When omitted, the first active event matching message_title or title is used.
message_titlestringOptionalActive event title used when event_id is omitted.
titlestringOptionalAlias for message_title.
statusstringOptionalNew event status. status_type is accepted as an alias.
status_typestringOptionalAlias for status.
payloadobjectOptionalOperator-response metadata stored with the status change.

Response payload

FieldTypeDescription
updatedbooleanWhether the event status was changed.
event_idstringResolved event ID.
statusstringStatus applied to the event.

Errors

  • No event ID/title can be resolved, no status is supplied, or resolved is requested while the event is still firing.