Skip to content

Commit

Permalink
Webhooks beta page with slug
Browse files Browse the repository at this point in the history
  • Loading branch information
ChuckCrawford committed Oct 13, 2022
1 parent fbbd906 commit f59e5ec
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 5 deletions.
54 changes: 49 additions & 5 deletions docs/webhooks/07-Webhooks-Beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,54 @@
tags: [webhooks]
---

# Webhooks v3 Beta

import Alert from 'react-bootstrap/Alert'
# Webhooks Early Access

<!-- theme: warning -->
### 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.
> **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"
}
```
6 changes: 6 additions & 0 deletions toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit f59e5ec

Please sign in to comment.