Skip to content

[Internal]: Expand/clarify webhook action variable interpolation docs #3751

@umbopepato

Description

@umbopepato

Description

The existing webhook action documentation shows a trivial example of how to interpolate variables in the request body with Mustache (only showing strings), and mentions how strings are escaped. However in webhook HTTP requests customers might want to send entire JSON objects or arrays from the action execution context (i.e. generated alerts data) as part of the body, which requires using a slightly different approach compared to simple strings.

In a recent SDH, a customer was confused by the docs, thinking they'd have to wrap the JSON object they wanted to interpolate in double quotes, as shown in the example. We might want to expand a bit the docs, showing how objects and arrays can be interpolated, or at least link the rules documentation that explains a bit about these kind of variables. A link to Mustache's own documentation might help too.

cc @nastasha-solomon

Resources

No new feature to learn, just the existing webhook action

Which documentation set does this change impact?

Elastic On-Prem and Cloud (all)

Feature differences

No diff

What release is this request related to?

N/A

Serverless release

Existing feature

Collaboration model

The documentation team

Point of contact.

Main contact: @umbopepato

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:ExperienceIssues owned by the Experience Docs Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions