1.4 Setting up Callbacks for Integration activation/deactivation

Embed Flow: Callbacks set up and lifecycle automation

Use Cases

There are multiple use cases for setting up callbacks in Embed Flows:

  • Registering/removing webhooks to trigger the Flow via webhook

  • Receiving the activation state for specific Flows and users

Summary in 4 minutes:


As a prerequisite, you need to have your own Connector and edit access to it. In case you do not have either of them, please reach out to us.

  1. Create a Flow that should be triggered whenever an Integration is activated and (optionally) a Flow that is triggered whenever an Integration is deactivated ("lifecycle Flows")

    1. These Flows send requests to your own Connector with callback parameters:

      1. Note: The JWT payload is available in these Flows and, when using the same Connector as in the Embed Flow, Authentication can be used from the Embed Flow by specifying {{ connectorAuth }} in the Dynamic Authentication ID field

  2. Create an Action for your Connector that is ideally called triggered_by_embed

    1. This action has the purpose of triggering the lifecycle flows and thus no method or endpoint needs to be specified

    2. Add the Flows you created to the Pre Save Flow and On Delete Flow fields respectively

    3. The action ideally has a password (first step of the created Flows in step #1) in order to prevent it from being used otherwise, thus the UI Form Schema field should be:

  "password": {
    "type": "password",
    "title": "Password for White Label Embed Creation Callback Flow",
    "required": true

3. Use the created Action at the beginning of your Embed Flows. This way, every time one of your users activates or deactivates an Embed Flow, the lifecycle Flows will be triggered.

Last updated