Update a Signal
Update a Signal by ID. All fields in the body are optional; only the fields you supply are applied.
enabled: Toggles the Signal on or off. Re-enabling a Signal that has already trained puts it back intoactive; otherwise it returns toonboarding.sensitivity: Sets how far a measurement must deviate from the trained normal band before the Signal fires. Not applicable topresenceSignals, and cannot be set on a Signal that has not yet trained.recipients: Replaces the Signal’s Recipient set. An empty array clears all Recipients. Modifying Recipients requires the Manage Recipients permission in addition to Manage Signals.
Authorizations
Authenticate using a Honeycomb Configuration Key.
Pass the Token in the X-Honeycomb-Team header:
If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.
To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.
Path Parameters
The unique identifier (ID) of a Signal.
Body
Fields to update on the Signal. All fields are optional.
Fields to update on a Signal. All fields are optional and only supplied fields are applied.
Turn the Signal on (true) or off (false).
true
Set the sensitivity bucket for error_rate Signals. Cannot be set on presence Signals or on Signals that have not yet trained.
low, medium, high "medium"
Replace the Signal's Recipient set with the given list. An empty array clears all Recipients. Each Recipient must be referenced by its id from the Recipients API. Requires the Manage Recipients permission in addition to Manage Signals.
Response
Success
A Signal with its assigned Recipients.
Unique identifier (ID) of the Signal.
"hcasp_01j9x1yq0k2t8m9n3v4b5r6c7d"
The name of the service the Signal monitors.
"checkout-api"
The slug of the dataset the Signal's service reports to.
"checkout-api"
The slug of the environment the Signal belongs to.
"production"
The kind of measurement the Signal is trained on.
error_rate, presence "error_rate"
Whether the Signal is currently enabled. Disabled Signals do not fire.
true
The lifecycle status of the Signal.
onboarding, training, active, false, ineligible "active"
How far a measurement must deviate from the trained normal band before the Signal fires. Always null for presence Signals, and null for any Signal that has not yet trained.
low, medium, high "medium"
When true, Honeycomb will automatically start an investigation when this Signal fires.
false
Whether the Signal is currently in an anomalous state.
false
The start time of the most recent anomaly, in seconds since UNIX epoch. null when the Signal has never been anomalous.
1741089600
The end time of the most recent anomaly, in seconds since UNIX epoch. null when no anomaly has ended yet, or the Signal is currently anomalous.
1741093200
The ISO8601-formatted time when the Signal was created.
"2025-02-14T17:32:11Z"
The ISO8601-formatted time when the Signal was last updated.
"2025-03-01T10:04:22Z"
The Recipients notified when this Signal fires.