Skip to navigation

agent.state_changed

Delivered when staff enable or disable the document-review agent. Generic: scope says whether the switch applies globally, to one organization, to one property or to one household, and each scope carries only its own id, every other id being null (GLOBAL: all null; ORGANIZATION: organizationId only; PROPERTY: propertyId only; HOUSEHOLD: householdId only). MVP: only the global kill switch is sent (scope GLOBAL), delivered once per property subscription with organizationId, propertyId and householdId all null. ORGANIZATION, PROPERTY and HOUSEHOLD are reserved for later and are not sent in the MVP.

Fortress POSTs this payload to the URL configured for your subscription. See Webhooks for delivery, signing and retry rules, and the event page for when it does and does not fire.

Payload

The payload of this webhook request is an object.
eventIdstringRequiredformat: "uuid"

Unique identifier for this event. Stable across delivery attempts, so consumers must dedupe on this value. Also sent as the X-Fortress-Event-Id header.

eventTypeenumRequired

What happened, in resource.action form. Also sent as the X-Fortress-Event-Type header. New values are added over time.

Allowed values:
occurredAtdatetimeRequired

ISO-8601 UTC timestamp of when the event occurred, not when it was delivered. A retried delivery carries the original occurredAt.

dataobjectRequired
Event payload. The shape is determined by eventType.

Response

200
Acknowledged. Return 2xx within the delivery timeout or Fortress retries.