The inference hook object

⚠️

Preview — this feature is being built; the design below is the spec.

The inference_hook object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "type": "inference_hook",
  "url": "https://ai-gateway.example.com/syntic-hook",
  "enabled": true,
  "timeout_ms": 1000,
  "failure_mode": "fail_closed",
  "include_content": true,
  "post_response": false,
  "workspace_ids": [],
  "sample_rate": 1.0,
  "updated_at": "2026-11-05T10:00:00Z",
  "signing_secret": "whsec_Nw9...redacted"
}

Fields

Field	Type	Description
`type`	string	The object type, always `inference_hook`.
`url`	string	See the endpoint pages below.
`enabled`	boolean	See the endpoint pages below.
`timeout_ms`	integer	See the endpoint pages below.
`failure_mode`	string	`closed` blocks the request when the hook times out or errors; `open` lets it through and logs it.
`include_content`	boolean	See the endpoint pages below.
`post_response`	boolean	See the endpoint pages below.
`workspace_ids`	array	Nested detail; see the endpoint pages below.
`sample_rate`	number	See the endpoint pages below.
`updated_at`	string	When it last changed.
`signing_secret`	string	See the endpoint pages below.

Returned by

group invite

Was this page helpful?