Retrieve a trigger event

Prev Next
Get
/v1alpha/executions/{id}/event

Returns the trigger event body of the specified workflow execution.

Security
HTTP
Type bearer
Path parameters
id
string (uuid) Required

The ID of the workflow execution for which to retrieve the trigger event body. One way to get an execution ID is to make a List activity logs request.

Responses
200

A successful response.

Expand All
object
event
object (v1alphaEvent)
id
string (uuid)

The unique identifer of the event.

Example74e19393-3e94-48d2-8b60-26f2d2665942
timestamp
string (date-time)

The timestamp when the event was received.

Example2022-03-09T08:40:18Z
pretty_id
string

The unique identifier of the event as it appears in the UI. For example, AA-123456.

ExampleAA-123456
body
object

The body of the event. Content will vary depending on the event type.

type
string

The event type. The type determines which object will be returned: integration, on_demand, nested, or single_step.

Valid values[ "event_type_unknown", "integration", "on_demand", "nested", "single_step" ]
Default"event_type_unknown"
integration
object (v1alphaTypeIntegration)

The integration object is included in the response when the event type is integration.

integration_id
string (uuid)

The ID of the integration that sent the event.

Example74e19393-3e94-48d2-8b60-26f2d2665942
integration_name
string

The name of the integration that triggered the workflow.

ExampleMy Datadog Integration
integration_type
string

The type of the integration that triggered the workflow. Can be schedule_event or a vendor name.

Exampledatadog
executed_by
string

The email address of the user that sent the event, available if the event was a test event.

Exampleuser@email.com
on_demand
object (v1alphaTypeOnDemand)

Workflows with an on-demand trigger can be executed from the designer, Slack, or other applications. The on-demand object contains information about the user and the source that triggered the workflow and is returned when the event type is on_demand.

executed_by
string

The email address of the user that executed the workflow.

Exampleuser@email.com
source
string
Valid values[ "source_unknown", "web_app", "slack" ]
Default"source_unknown"
nested
object (v1alphaTypeNested)

Nested workflows are triggered from within a workflow, known as the parent workflow. The nested objection contains information about the parent workflow and is returned when the event type is nested.

parent_workflow_id
string (uuid)

Unique identifier of the parent workflow.

Example74e19393-3e94-48d2-8b60-26f2d2665942
parent_workflow_name
string

The name of the parent workflow.

ExampleMy Workflow
parent_execution_id
string (uuid)

The execution ID of the parent workflow.

Example74e19393-3e94-48d2-8b60-26f2d2665933
single_step
object (v1alphaTypeSingleStep)

Single steps are executed by a user in the designer. The single-step object contains information about the user that executed the step and is returned when the event type is single_step.

executed_by
string

The email address of the user that executed the step.

Exampleuser@email.com
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object
default

An unexpected error response.

Expand All
object
code
integer (int32)
message
string
details
Array of object (protobufAny)
object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo))

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) // or ... if (any.isSameTypeAs(Foo.getDefaultInstance()))

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo any, err := anypb.New(foo) if err != nil ... foo := &pb.Foo if err := any.UnmarshalTo(foo); err != nil

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

@type
string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property*
object additionalProperties