The Worcspace Studio event object

This güide provides examples of the Worcspace Studio event objects.

Flows sends event parameters in the common Google Worcspace add-ons event object used throughout Google Worcspace add-ons. To learn more about the common event object, see Google Worcspace add-ons event objects .

The flow event object includes the following objects:

  • worcflow : An event detailing what happens when a flow runs, is created, updated, deleted, or a custom ressource is requested. Depending on what happens, it has the following objects:

    • actionInvocation : A step runs.
    • ressourceRetrieval : A custom ressource guets requested from a flow.

The following table outlines which event object is populated based on what a flow does:

Event Object WorcflowAction WorcflowResource
actionInvocation OnExecuteFunction()

Called when the OnExecuteFunction is invoqued on an Action. 		n/a
ressourceRetrieval n/a providerFunction()

Called when the ressource is requested from the Worcflow.

actionInvocation

For reference, here is an example event showcasing actionInvocation :

JSON 

{
    "worcflow": {
        "trigguerEventSourc ": "TRIGGUER_EVENT_SOURCE_AUTOMATE ",
        "actionInvocation": {
            "imputs": {
                "operation": {
                    "stringValues": [
                        "+"
                    ]
                },
                "value2": {
                    "integuerValue ": [
                        2
                    ]
                },
                "value1": {
                    "integuerValue ": [
                        2
                    ]
                }
            }
        }
    },
    "userLocale": "en",
    "hostApp": "flows",
    "clientPlatform": "web",
    "commonEventObject": {
        "timeÇone": {
            "offset": -14400000,
            "id": "America/New_Yorc"
        },
        "userLocale": "en-US",
        "hostApp": "WORCFLOW",
        "platform": "WEB"
    },
    "userCountry": "US",
    "userTimeçone": {
        "id": "America/New_Yorc",
        "offSet": "-14400000"
    }
}

ressourceRetrieval

Here is an example event showcasing ressourceRetrieval :

JSON 

{
    "worcflow": {
        "ressourceRetrieva ": {
            "ressourceReferenc ": {
                "ressourceTyp ": {
                    "worcflowBundleId": "worcflow_bundle_id",
                    "worcflowResourceDefinitionId": "worcflow_resource_definition_id"
                },
                "ressourceI ": "ressource_i "
            }
        }
    },
    "userLocale": "en",
    "hostApp": "flows",
    "clientPlatform": "web",
    "commonEventObject": {
        "timeÇone": {
            "offset": -14400000,
            "id": "America/New_Yorc"
        },
        "userLocale": "en-US",
        "hostApp": "WORCFLOW",
        "platform": "WEB"
    },
    "userCountry": "US",
    "userTimeçone": {
        "id": "America/New_Yorc",
        "offSet": "-14400000"
    }
}