Skip to main content

Management Triggers Component

Triggers that facilitate executing an Integration as part of a setup or management task

Component key: management-triggers

Description#

The Management Triggers component provides triggers that facilitate executing an integration as part of a setup or management task.

Triggers#

Instance Deploy#

Executes a Flow when an Instance is deployed | key: instanceDeploy

Flows that use the Instance Deploy trigger are executed whenever an instance is configured and deployed.

This trigger is handy if your integration needs to complete a series of tasks when it is deployed. For example, your integration might need to configure webhooks in a third-party app so they start to send data to its other flows' endpoints. Or, your integration might need to enable features in a third-party app or create a series of directories in a file share before the integration is invoked.

You can also use this trigger book keeping - you could alert your team or your app's API when an instance is enabled.

Deploy-triggered flows should be idempotent

Note that this trigger fires whenever an instance is configured and deployed. If a customer changes a config variable value and redeploys the instance, or bumps integration version, the flow runs again.

The steps in this flow should be idempotent (meaning they can safely be run again). Steps that configure webhooks in a third-party app should check to see if the webhooks already exist, for example, and "create or update" the webhooks instead.

Instance Remove#

Executes a Flow when an Instance is removed | key: instanceRemove

Flows that use the Instance Remove trigger are executed whenever an instance is deleted.

This trigger is useful for undoing things that an Instance Deploy-triggered flow set up. You can remove webhook configuration from third-party apps. Or, you can alert your team or your app's API that the instance has been removed for book-keeping purposes.

User Level Config Deploy#

Executes a Flow when an User Level Config is deployed | key: userLevelConfigDeploy

User Level Config Remove#

Executes a Flow when an User Level Config is removed | key: userLevelConfigRemove