From f59e5eca693f3378904a8ca4052bfe2bc12ee627 Mon Sep 17 00:00:00 2001 From: Charlie Crawford Date: Thu, 13 Oct 2022 10:20:01 -0400 Subject: [PATCH] Webhooks beta page with slug --- docs/webhooks/07-Webhooks-Beta.md | 54 ++++++++++++++++++++++++++++--- toc.json | 6 ++++ 2 files changed, 55 insertions(+), 5 deletions(-) diff --git a/docs/webhooks/07-Webhooks-Beta.md b/docs/webhooks/07-Webhooks-Beta.md index 2e2a90f..d8d957f 100644 --- a/docs/webhooks/07-Webhooks-Beta.md +++ b/docs/webhooks/07-Webhooks-Beta.md @@ -2,10 +2,54 @@ tags: [webhooks] --- -# Webhooks v3 Beta - -import Alert from 'react-bootstrap/Alert' +# Webhooks Early Access -### V3 Webhooks are in Early Access -The v3 Webhook features described on this page are still under development. The features are subject to change at any time. This page is for informational purposes only. \ No newline at end of file +> **Early Access Webhooks v3 Features** +> +> The items described on this page are still under development and are subject to change at any time. This page is for informational purposes only. + +## Event Types + +### incident.action_invocation.created +`data.type` is [`incident_action_invocation`](#incident_action_invocation) + +A Rundeck Action has been newly invoked on an existing Incident. The resource representing this Invocation has a state of "created", indicating it exists, but no progress has been made on it as yet. + +### incident.action_invocation.updated +`data.type` is [`incident_action_invocation`](#incident_action_invocation) + +A Rundeck Action Invocation, running on an Incident, has had its lifecycle state updated. The Invocation is still considered active, and further lifecycle updates are expected. + +### incident.action_invocation.terminated +`data.type` is [`incident_action_invocation`](#incident_action_invocation) + +A Rundeck Action Invocation, running on an Incident, has had its lifecycle state updated to a terminal state. This means it has completed, either successfully or in error, and no further updates will be made. + +## Event Data Types + +### incident_action_invocation + +```json +{ + "id": "01CELD6T9C2JS745I7CAK0LRRF", + "self": "https://api.pagerduty.com/automation/invocations/01CELD6T9C2JS745I7CAK0LRRF", + "html_url": "https://acme.pagerduty.com/rundeck-actions/actions/01CDYN0IRV4VG991K5FR73YNTW/invocations/01CELD6T9C2JS745I7CAK0LRRF/report", + "incident": { + "html_url": "https://acme.pagerduty.com/incidents/PBAZLIU", + "id": "PBAZLIU", + "self": "https://api.pagerduty.com/incidents/PBAZLIU", + "summary": "An Incident", + "type": "incident_reference" + }, + "action": { + "html_url": "https://acme.pagerduty.com/rundeck-actions/actions/01CDYN0IRV4VG991K5FR73YNTW", + "id": "01CDYN0IRV4VG991K5FR73YNTW", + "self": "https://api.pagerduty.com/automation/actions/01CDYN0IRV4VG991K5FR73YNTW", + "summary": "A Helpful Action", + "type": "action_reference" + }, + "state": "created", + "type": "incident_action_invocation" +} +``` diff --git a/toc.json b/toc.json index a28bbf4..6fdceda 100644 --- a/toc.json +++ b/toc.json @@ -264,6 +264,12 @@ "title": "Verifying Signatures", "uri": "docs/webhooks/04-Signatures.md" }, + { + "type": "item", + "title": "Early Access", + "slug": "webhooks/early-access", + "uri": "docs/webhooks/07-Webhooks-Beta.md" + }, { "type": "item", "title": "Public Certificates",