Trigger workflows from webhook

[alexec]

Summary

Allow automated scripts to trigger workflows from a webhook.

Motivation

Simplify trigger or workflows.

Proposal

TBD

---

Message from the maintainers:

If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.

[nHurD]

I'm curious how this would differ from Argo Events?

[sarabala1979]

This is mainly to support simple use-case like just user wants to trigger the workflow/workflows based on webhook invoke. Argo Event is a sophisticated application to support many usecases with multiple event sources, condition-based trigger, and complex event trigger logics.

[salanki]

Triggering Workflows via the new REST API is already pretty simple, however it requires a Workflow body even when triggering a WorkflowTemplate.

Is the idea here to support triggering a WorfklowTemplate by simply including parameters in the query? Ie /api/submit/workflowtemplate/my-template?param1=cow&param2=say? I can see that being very useful, I've built my own proxy for this for my own usage.

[alexec]

The biggest difference for this would be the use of a token (like GITHUB_TOKEN) to escalate an anonymous user to one that is able to submit workflows as the system user. This makes it much easier and safer to use.

[salanki]

Yup, that makes a lot of sense.

[sarabala1979]

Triggering Workflows via the new REST API is already pretty simple, however it requires a Workflow body even when triggering a WorkflowTemplate.

Is the idea here to support triggering a WorfklowTemplate by simply including parameters in the >query? Ie /api/submit/workflowtemplate/my-template?param1=cow&param2=say? I can see >?>that being very useful, I've built my own proxy for this for my own usage.

In V2.7, Argo workflow has a Submittable workflowtemplate . User can submit the workflowtemplate as workflow. Webhook should have a generalized Authentication mechanism to authenticate the call.

[nHurD]

Wow, this sounds pretty awesome! Would the result of this return the generated name of the new workflow?

[alexec]

@whynowy has an example of how to do this, but the big challenge is that the payload of different systems varies. E.g. https://developer.github.com/webhooks/

Argo Events would be able to do this:

https://argoproj.github.io/argo-events/tutorials/03-trigger-sources/#git

[whynowy]

@alexec - The link your gave is an example about how to trigger a git action not a github notification, check following links for a right example.

https://github.com/argoproj/argo-events/blob/master/examples/event-sources/github.yaml
https://github.com/argoproj/argo-events/blob/master/examples/gateways/github.yaml
https://github.com/argoproj/argo-events/blob/master/examples/sensors/github.yaml

[alexec]

@whynowy do you want to add your Google do to /docs?

[alexec]

Please review the proposal:

https://github.com/alexec/argo/blob/cloudevents/docs/events.md

[alexec]

@nHurD, @deepk2u, @kmarquardsen, @juanchristensen, @kabilan6, @samath117, @shrimank, @maguowei, @oleg-borodai, @nikopen please can your review the proposal:

https://github.com/alexec/argo/blob/cloudevents/docs/events.md

[alexec]

Please remember to 👍 #3344 if you want to be able to resume suspended workflows.

[alexec]

@nHurD, @deepk2u, @kmarquardsen, @juanchristensen, @kabilan6, @samath117, @shrimank, @maguowei, @oleg-borodai, @nikopen request for comment:
https://docs.google.com/document/d/1f2z6W0pI86z28T_GI-jgchlJ1twFmV37qla-Lm3egYk/edit

[alexec]

Available for testing in v2.11.0-rc1.