Skip to main content
PATCH
Update trigger

Authorizations

Authorization
string
header
required

Pass your pk_live_... API key as a Bearer token.

Path Parameters

trigger_id
string
required

Body

application/json
name
string | null

Replace the display name; pass null to clear it.

Required string length: 1 - 128
enabled
boolean | null

Set true to re-enable a trigger, including one that was disabled automatically — this resets consecutive_failures to 0.

filter
Filter · object | null
delivery
WebhookDelivery · object | null
kind

Replace the kind list — a list, or a single id as shorthand. Use '*' for any kind.

entity_observation_fuzzy
boolean | null

Accept fuzzy-matched entity observations in addition to exact matches. Only applies to 'observed'-action triggers on entity kinds.

Response

Successful Response

id
string
required
user_id
string
required
kind
string[]
required

Kind ids this trigger fires for; ['*'] means any kind.

action
string
required
delivery
Delivery · object
required
enabled
boolean
required
name
string | null

Display name, if you set one.

filter
Filter · object | null
entity_observation_fuzzy
boolean
default:false

Whether fuzzy-matched entity observations are accepted in addition to exact matches.

secret
string | null

Webhook signing secret, returned only in the create response — store it. Each delivery carries an 'Adapter-Signature: v1=' header; verify it by computing HMAC-SHA256 over '.' with this secret and comparing hex digests. Reject deliveries whose timestamp is older than your replay window.

created_at
string<date-time> | null
updated_at
string<date-time> | null
last_fired_at
string<date-time> | null

When this trigger last matched an event and delivery was attempted, including failed deliveries.

last_status
enum<string> | null

Outcome of your most recent delivery. Null until the trigger first fires.

Available options:
delivered,
failed
consecutive_failures
integer
default:0

Consecutive events that failed to deliver, counted once per event after its final retry. Resets to 0 on success. At 50 the trigger is disabled automatically.

auto_disabled_at
string<date-time> | null

Set when the trigger was disabled automatically after 50 consecutive events failed to deliver. Fix your endpoint, then update the trigger with enabled=true to resume.