StackStorm / StackStorm/st2

Custom webhook response content

Open
#2,475 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement feature
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

Some webservices support outgoing webhooks that could be pointed to st2, however they expect certain fields to be contained in the response. Feature request is to enable some way for st2 to return custom JSON payload in response to webhooks. One possibility would be to mark (in the yaml) which action st2 should execute and take the stdout to use as the webhook response. This would also require blocking the 200/202 response until 'webhook response' Action has completed.

One such webservice is Amazon's Alexa (Echo). Alexa can call an st2 webhook when some pre-configured 'Intent' is called, however Alexa expects the webhook response to contain instructions on how to proceed with interacting with the end-user. (This response could come from STDOUT of a script that st2 runs).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; start by tracing the existing webhook request/response handling and action execution flow. Done would mean a configured webhook can return a custom JSON payload, including action output when selected, and waits for that response action to complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.