API ReferenceTriggers

Update a triggerv3.0

PATCH
/api/v3/trigger_instances/manage/{triggerId}

Updates a trigger instance. Pass status to enable or disable it: disabling pauses event listening without deleting the trigger configuration, and re-enabling restores it. Pass egress_url to override where this instance delivers its events (null removes the override); the project webhook subscription is still required and still controls signing, the payload version and which events are enabled. Send either field or both. On a project with 2FA enabled, user_id is required to set egress_url and, whenever sent, must own the connected account behind the trigger.

Authorization

x-api-key<token>

Project API key authentication

In: header

Path Parameters

triggerIdstringRequired

The ID of the trigger instance to update

Format: triggerInstanceId

Request Body

application/json

statusenum

Enable or disable the trigger instance.

Possible values:
enabledisable
user_idstring

The user id that owns the connected account behind this trigger. Optional: when sent on a project with 2FA enabled it must be the owner of a private connection or allowed on a shared one, whatever is being updated. Required to set egress_url when 2FA is enabled. Ignored when 2FA is disabled.

egress_urlnullable string

Overrides the delivery URL for this trigger instance only: its events are sent to this HTTPS URL instead of the project webhook URL. Your project webhook subscription is still required and still controls signing (the webhook secret), the payload version and which events are enabled; only the destination changes for this instance. Omit to leave the current value unchanged; pass null to remove the override and deliver to the project webhook URL again.

Format: uri

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v3/trigger_instances/manage/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "success"}
Edit this page on GitHub