Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Commit 0e53ead

Browse files
authored
Creates Google Workflow Target Documentation (#147)
1 parent e5ddeea commit 0e53ead

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

docs/targets/googlecloudworkflows.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Event Target for Google Cloud Workflows
2+
3+
This event target receives [CloudEvents][ce] over HTTP and sends them to [Google Cloud Workflows](https://cloud.google.com/workflows)
4+
5+
## Prerequisite(s)
6+
7+
- Google Cloud Console account.
8+
- A service account and it's associated JSON credentials.
9+
10+
## Deploying an Instance of the Target
11+
12+
Open the Bridge creation screen and add a target of type `Google Cloud Workflows`.
13+
14+
In the Target creation form, give a name to the event Target and add the following information:
15+
16+
- **Credentials**: Reference to a [TriggerMesh secret](../guides/secrets.md) containing the JSON credentials of a Service Account.
17+
18+
After clicking the `Save` button, you will be taken back to the Bridge editor. Proceed to adding the remaining
19+
components to the Bridge, then submit it.
20+
21+
A ready status on the main _Bridges_ page indicates that the Google Cloud Workflows target is ready to accept events.
22+
23+
For more information about using Google Cloud Workflows, please refer to the [documentation][https://cloud.google.com/workflows/docs].
24+
25+
## Event Types
26+
### io.trigermesh.google.workflows.run
27+
28+
Events of this type contain nuanced data that is used to run a Google Workflow.
29+
30+
This type expects a [JSON][ce-jsonformat] payload with the following properties:
31+
32+
| Name | Type | Comment | Example
33+
|---|---|---|---|
34+
| **parent** | string | Project and location in which the workflow should be created. Format: `projects/{project}/locations/{location}` | "projects/ultra-hologram-297914/locations/us-central1" |
35+
| **executionName** | string | The resource name of the execution. Format: `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}`| "demowf" |
36+
37+
[ce]: https://cloudevents.io/
38+
[ce-jsonformat]: https://github.com/cloudevents/spec/blob/v1.0/json-format.md

docs/targets/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The following is a list of Triggermesh event destinations known as `Targets`. So
1515
- [Confluent](./confluent.md): Forward events to Confluent Kafka.
1616
- [Datadog](./datadog.md): Forward event payload to Datadog.
1717
- [Elasticsearch](./elasticsearch.md): Send events to Elasticsearch to be indexed.
18+
- [Google Cloud Workflows](./googlecloudworkflows.md): Execute Google Cloud Workflows with Cloudevents.
1819
- [Google Firestore](./googlefirestore.md): Send events to Google Firestore
1920
- [Google Sheets](./googlesheets.md): Append events to a GoogleSheets Sheet row.
2021
- [Hasura](./hasura.md): Send GraphQL queries to Hasura.
@@ -29,4 +30,4 @@ The following is a list of Triggermesh event destinations known as `Targets`. So
2930
- [Splunk](./splunk.md): Forward arbitrary events to Splunk.
3031
- [Tekton](./tekton.md): Use event to submit a Tekton build.
3132
- [Twilio](./twilio.md): Send an SMS via Twilio in response to events.
32-
- [Zendesk](./zendesk.md): Perform actions in Zendesk upon reception of certain events.
33+
- [Zendesk](./zendesk.md): Perform actions in Zendesk upon reception of certain events.

0 commit comments

Comments
 (0)