Triggers

Update a trigger

Changed on

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. When a webhook trigger is disabled, Composio also attempts to remove the webhook it received events through at the provider, once no other active trigger uses it. This runs in the background after the response, with retries if the provider fails. Re-enabling a webhook trigger sets it up with the provider again. 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. On a shared connected account, user_id is required to enable the trigger or set egress_url, and is checked against the connection's ACL.

patch/api/v3.1/trigger_instances/manage/{triggerId}

Request

  • Base URL
    https://backend.composio.dev
  • URL
    https://backend.composio.dev/api/v3.1/trigger_instances/manage/{triggerId}
  • Auth
    • API key in header x-api-key
    • or API key in header x-user-api-key

Path parameters

triggerIdstring triggerInstanceId required

The ID of the trigger instance to update

Request body

status'enable' | 'disable'

Enable or disable the trigger instance.

user_idstring

The user id acting on the connected account behind this trigger. On a shared connection it must be allowed by the connection ACL, and it is required to enable the trigger or set egress_url. On a private connection it must be the owner when the project has 2FA enabled, and is ignored when 2FA is disabled. Required to set egress_url when 2FA is enabled.

egress_urlstring uri nullable

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.

Response

Successfully updated trigger status

status'success' required

Status of the operation

Changes

    • breaking

      request body became required

    • info

      api operation id patchV3_1TriggerInstancesManageByTriggerId removed and replaced with patchTriggerInstancesManageByTriggerId

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      the endpoint scheme security CookieAuth was removed from the API