[ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook #197437

js-jankisalvi · 2024-10-23T13:29:38Z

Summary

Resolves #178074

This PR allows to use POST method and JSON payload for body for get case information in case management webhook.

How to test

Create a case management webhook connector as per documentation
Use any public API which supports GET and POST methods
Use POST method for Get case information
Verify that it validates the URL and JSON payload correctly
Test the connector using Test tab
Create a rule with action using case management webhook connector
Verify alerts are generated and action executed without any errors

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)

elasticmachine · 2024-10-24T14:23:47Z

Pinging @elastic/response-ops (Team:ResponseOps)

…ub.com/js-jankisalvi/kibana into case-management-webhook-post-case-info

adcoelho · 2024-10-31T14:00:07Z

The field now also allows PUT and PATCH requests but I think those might be by mistake.

Zacqary

Looks mostly good, just need to limit the Get step to GET and POST

x-pack/plugins/stack_connectors/public/connector_types/cases_webhook/steps/get.tsx

js-jankisalvi · 2024-11-01T10:21:08Z

The field now also allows PUT and PATCH requests but I think those might be by mistake.

Previously used the same options in dropdown as create and update. But now changed to use only GET and POST

Zacqary

LGTM!

...ng_api_integration/security_and_spaces/group2/tests/actions/connector_types/cases_webhook.ts

adcoelho · 2024-11-06T11:31:50Z

x-pack/plugins/stack_connectors/server/connector_types/cases_webhook/service.ts

+            })
+          : null;
+
+      if (json !== null) {


Shouldn't this be

Suggested change

if (json !== null) {

if (getIncidentMethod === WebhookMethods.POST && json !== null) {

I'm not sure 🤔

I am checking this at line 120:

const json = getIncidentMethod === WebhookMethods.POST && getIncidentJson ? renderMustacheStringNoEscape() : null

So json will be null if getIncidentMethod is not WebhookMethods.POST

adcoelho · 2024-11-06T14:33:16Z

I saw that you do validator: containsExternalIdForPost(getIncidentMethod) and was curious about the ansible API.

In the original enhancement request, the client uses Ansible, and a specific example is given.

We want to use Ansible, to retrieve the case information. Ansible only allows POST requests. it would look something like this:

POST https://ansible.domain/api/v2/job_templates/100/
{
"whateverKey": {{{external.system.id}}}
}

But then I checked the documentation for this api/v2/job_templates endpoint and it really doesn't seem to match the "retrieve case information" scenario. Check this out.

Make a POST request to this resource with the following job template fields to create a new job template associated with this organization.

I don't know what a job template is but it doesn't feel like it matches the view case scenario 😆

x-pack/plugins/stack_connectors/public/connector_types/cases_webhook/steps/get.tsx

adcoelho

LGTM! I left some small comments but the only thing I find more important is containsExternalIdForPost i'd be up for removing it wdyt?

Ah and also the comment about the original feature request. I hope this fixes it for them but I dunno if this isn't a case of misconfiguring the connector :D

js-jankisalvi · 2024-11-06T16:00:16Z

But then I checked the documentation for this api/v2/job_templates endpoint and it really doesn't seem to match the "retrieve case information" scenario. Check this out.

Agree, The docs does not show any POST method to get job templates information. But using a post to get data is possible with some APIs. So I think it's a good option to provide.

I don't know what a job template is but it doesn't feel like it matches the view case scenario 😆

Do you think we should ask them? @cnasikas

cnasikas · 2024-11-07T08:21:21Z

But then I checked the documentation for this api/v2/job_templates endpoint and it really doesn't seem to match the "retrieve case information" scenario. Check this out.

Agree, The docs does not show any POST method to get job templates information. But using a post to get data is possible with some APIs. So I think it's a good option to provide.

I don't know what a job template is but it doesn't feel like it matches the view case scenario 😆

Do you think we should ask them? @cnasikas

I also agree. We should go with the feature either way as it is a valid scenario.

elasticmachine · 2024-11-07T12:10:18Z

💚 Build Succeeded

Buildkite Build
Commit: e5d078d

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`stackConnectors`	681.3KB	686.1KB	+4.7KB

History

💚 Build #248927 succeeded eb46790
💚 Build #248200 succeeded ac83049
💔 Build #247939 failed 01b1307
💚 Build #247745 succeeded cb8554f
💔 Build #247715 failed 5eb6019
💛 Build #246982 was flaky 014790c

cc @js-jankisalvi

kibanamachine · 2024-11-07T12:45:12Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11723252200

…mation in case management webhook (elastic#197437) ## Summary Resolves elastic#178074 This PR allows to use POST method and JSON payload for body for get case information in case management webhook. <img width="1279" alt="Screenshot 2024-10-24 at 15 02 33" src="https://github.com/user-attachments/assets/aaabc5b8-cd9e-46d6-aab8-85a27731bd88"> ### How to test - Create a case management webhook connector [as per documentation](https://www.elastic.co/guide/en/kibana/master/cases-webhook-action-type.html) - Use any public API which supports GET and POST methods - Use POST method for Get case information - Verify that it validates the URL and JSON payload correctly - Test the connector using Test tab - Create a rule with action using case management webhook connector - Verify alerts are generated and action executed without any errors ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) (cherry picked from commit d81d071)

kibanamachine · 2024-11-07T12:49:49Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

… information in case management webhook (#197437) (#199307) # Backport This will backport the following commits from `main` to `8.x`: - [[ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook (#197437)](#197437)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Janki Salvi <[email protected]>

…mation in case management webhook (elastic#197437) ## Summary Resolves elastic#178074 This PR allows to use POST method and JSON payload for body for get case information in case management webhook. <img width="1279" alt="Screenshot 2024-10-24 at 15 02 33" src="https://github.com/user-attachments/assets/aaabc5b8-cd9e-46d6-aab8-85a27731bd88"> ### How to test - Create a case management webhook connector [as per documentation](https://www.elastic.co/guide/en/kibana/master/cases-webhook-action-type.html) - Use any public API which supports GET and POST methods - Use POST method for Get case information - Verify that it validates the URL and JSON payload correctly - Test the connector using Test tab - Create a rule with action using case management webhook connector - Verify alerts are generated and action executed without any errors ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/))

initial commit

283a8b8

js-jankisalvi self-assigned this Oct 23, 2024

Fix tests

629a867

js-jankisalvi added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.17.0 release_note:skip Skip the PR/issue when compiling release notes Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX labels Oct 24, 2024

Merge branch 'main' into case-management-webhook-post-case-info

134675e

js-jankisalvi marked this pull request as ready for review October 24, 2024 14:23

js-jankisalvi requested a review from a team as a code owner October 24, 2024 14:23

js-jankisalvi added v9.0.0 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Oct 24, 2024

js-jankisalvi requested review from adcoelho and jcger October 24, 2024 14:28

js-jankisalvi and others added 4 commits October 24, 2024 16:02

make system id optional in getIncidentUrl for POST

d9d7949

Merge branch 'case-management-webhook-post-case-info' of https://gith…

3e59d59

…ub.com/js-jankisalvi/kibana into case-management-webhook-post-case-info

Merge branch 'main' into case-management-webhook-post-case-info

e0a8210

Merge branch 'main' into case-management-webhook-post-case-info

014790c

Zacqary requested changes Oct 31, 2024

View reviewed changes

x-pack/plugins/stack_connectors/public/connector_types/cases_webhook/steps/get.tsx Outdated Show resolved Hide resolved

use only get and post

5eb6019

js-jankisalvi requested a review from Zacqary November 1, 2024 10:29

js-jankisalvi added 3 commits November 1, 2024 12:23

Merge branch 'main' into case-management-webhook-post-case-info

cb8554f

Merge branch 'main' into case-management-webhook-post-case-info

01b1307

Merge branch 'main' into case-management-webhook-post-case-info

ac83049

Zacqary approved these changes Nov 5, 2024

View reviewed changes

adcoelho reviewed Nov 6, 2024

View reviewed changes

adcoelho approved these changes Nov 6, 2024

View reviewed changes

feedback 2

eb46790

js-jankisalvi and others added 2 commits November 7, 2024 10:26

removed externalId validation for json

5ab4836

Merge branch 'main' into case-management-webhook-post-case-info

e5d078d

js-jankisalvi merged commit d81d071 into elastic:main Nov 7, 2024
22 checks passed

js-jankisalvi deleted the case-management-webhook-post-case-info branch November 7, 2024 12:44

kibanamachine mentioned this pull request Nov 7, 2024

[8.x] [ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook (#197437) #199307

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook #197437

[ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook #197437

js-jankisalvi commented Oct 23, 2024 •

edited by kibanamachine

Loading

elasticmachine commented Oct 24, 2024

adcoelho commented Oct 31, 2024

Zacqary left a comment

js-jankisalvi commented Nov 1, 2024 •

edited

Loading

Zacqary left a comment

adcoelho Nov 6, 2024 •

edited

Loading

js-jankisalvi Nov 6, 2024

adcoelho commented Nov 6, 2024

adcoelho left a comment

js-jankisalvi commented Nov 6, 2024

cnasikas commented Nov 7, 2024

elasticmachine commented Nov 7, 2024

kibanamachine commented Nov 7, 2024

kibanamachine commented Nov 7, 2024

	if (json !== null) {
	if (getIncidentMethod === WebhookMethods.POST && json !== null) {

[ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook #197437

[ResponseOps][Connectors] Allow to use POST method for get case information in case management webhook #197437

Conversation

js-jankisalvi commented Oct 23, 2024 • edited by kibanamachine Loading

Summary

How to test

Checklist

elasticmachine commented Oct 24, 2024

adcoelho commented Oct 31, 2024

Zacqary left a comment

Choose a reason for hiding this comment

js-jankisalvi commented Nov 1, 2024 • edited Loading

Zacqary left a comment

Choose a reason for hiding this comment

adcoelho Nov 6, 2024 • edited Loading

Choose a reason for hiding this comment

js-jankisalvi Nov 6, 2024

Choose a reason for hiding this comment

adcoelho commented Nov 6, 2024

adcoelho left a comment

Choose a reason for hiding this comment

js-jankisalvi commented Nov 6, 2024

cnasikas commented Nov 7, 2024

elasticmachine commented Nov 7, 2024

💚 Build Succeeded

Metrics [docs]

Async chunks

History

kibanamachine commented Nov 7, 2024

kibanamachine commented Nov 7, 2024

💚 All backports created successfully

Questions ?

js-jankisalvi commented Oct 23, 2024 •

edited by kibanamachine

Loading

js-jankisalvi commented Nov 1, 2024 •

edited

Loading

adcoelho Nov 6, 2024 •

edited

Loading