Create step

Performs one act on an incident: it stamps the act's time, moves the state, appends the act to the trail, and runs what the act sets in motion — a unit…

POST /v1/patrol/incident/{name}/step

Patrol → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/patrol/incident/{name}/step`
Method	`POST`
Operation	`post_patrol_incident_by_name_step`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Performs one act on an incident: it stamps the act's time, moves the state, appends the act to the trail, and runs what the act sets in motion — a unit assigned, a site secured, a report filed, a controller told.

The states run forward only. An act from a state it does not leave is 409 naming the state the incident is in, and a caller without the act's roles is refused.

Request

7 fields, body application/json (required).

Field	In	Type	Required	Description
`name`	path	string	yes	Name is the incident's document name, from the path.
`act`	body	string	—	Act is VERIFY, DISPATCH, ROLL, ARRIVE, CHECK, SECURE, FILE, CLOSE or ESCALATE.
`detail`	body	string	—	Detail is what to write on the trail with this act.
`false`	body	boolean	—	False says the activation turned out to be nothing, read by CLOSE.
`name`	body	string	—	Name is the incident's document name, from the path.
`outcome`	body	string	—	Outcome is what the incident came to, read by CLOSE.
`unit`	body	string	—	Unit is the call sign to send, read by DISPATCH.

Response

Status	Body	Meaning
`200`	patrol.patrolIncidentOut	ok
`default`	problem-details	refused

200 body — 34 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolIncident	—
`data.checked`	body	string	—	Checked is when the premises had been walked.
`data.clocks`	body	patrol.patrolClock[]	—	Clocks is the SLA clocks, present on a single-incident read.
`data.clocks[].elapsed`	body	integer (int64)	—	Elapsed is the seconds run so far, or the seconds it took when settled.
`data.clocks[].label`	body	string	—	Label names the clock: Verify, Dispatch or On site.
`data.clocks[].settled`	body	integer (int64)	—	Settled is the seconds it took, or -1 while the clock is still running.
`data.clocks[].target`	body	integer (int64)	—	Target is the contracted seconds.
`data.closed`	body	string	—	Closed is when the incident was closed.
`data.dispatched`	body	string	—	Dispatched is when a unit was assigned.
`data.enroute`	body	string	—	Enroute is when that unit started moving.
`data.escalated`	body	string	—	Escalated is when it was escalated, or empty.
`data.false`	body	boolean	—	False says the activation turned out to be nothing.
`data.filed`	body	string	—	Filed is when the report was written.
`data.name`	body	string	—	Name is the incident's document name.
`data.onsite`	body	string	—	Onsite is when it arrived.
`data.opened`	body	string	—	Opened is when the activation landed.
`data.outcome`	body	string	—	Outcome is what it came to.
`data.ref`	body	string	—	Ref is the receiving centre's own reference.
`data.secured`	body	string	—	Secured is when the site was made safe.
`data.site`	body	string	—	Site is where it is happening.
`data.sla`	body	integer (int64)	—	SLA is the contracted response time in minutes.
`data.state`	body	string	—	State is one of received, verified, dispatched, enroute, onsite, checked, secured, filed and closed.
`data.steps`	body	patrol.patrolAct[]	—	Steps is the act trail, present on a single-incident read.
`data.steps[].act`	body	string	—	Act is the act performed.
`data.steps[].actor`	body	string	—	Actor is who performed it.
`data.steps[].at`	body	string	—	At is when it happened.
`data.steps[].detail`	body	string	—	Detail is what they wrote with it.
`data.steps[].from`	body	string	—	From is the state the incident left.
`data.steps[].to`	body	string	—	To is the state it landed in.
`data.tier`	body	string	—	Tier is the site's contracted service tier.
`data.trigger`	body	string	—	Trigger is what the panel reported.
`data.unit`	body	string	—	Unit is the call sign attending, or empty.
`data.verified`	body	string	—	Verified is when the activation was confirmed real.
`data.zone`	body	string	—	Zone is the panel zone that reported.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol incident step <name>

import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPatrolIncidentByNameStep({ name: 'name', act: "<act>", detail: "<detail>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).post_patrol_incident_by_name_step(name='name', act="<act>", detail="<detail>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatrolAPI.PostPatrolIncidentByNameStep(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, patrol_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = patrol_api::post_patrol_incident_by_name_step(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PatrolApi(client).postPatrolIncidentByNameStep();

The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X POST https://api.hanzo.ai/v1/patrol/incident/<name>/step \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "act": "<act>",
       "detail": "<detail>"
     }'

MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.

Patrol API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page