Skip to content

Commit 2f9c867

Browse files
committed
add space to list items
1 parent 8758d0c commit 2f9c867

File tree

1 file changed

+68
-5
lines changed

1 file changed

+68
-5
lines changed

docs/guides/all/orchestrate-incident-response-with-ai.md

Lines changed: 68 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ We will configure the necessary blueprint to support our AI-powered incident orc
4141
The incident blueprint will store incident data from your incident management tool and track orchestration results.
4242

4343
1. Go to the [builder](https://app.getport.io/settings/data-model) page of your portal.
44+
4445
2. Click on `+ Blueprint`.
46+
4547
3. Click on the `{...} Edit JSON` button.
48+
4649
4. Copy and paste the following JSON configuration:
4750

4851
<details>
@@ -202,8 +205,11 @@ The incident blueprint will store incident data from your incident management to
202205
Port's PagerDuty integration creates a `pagerdutyIncident` blueprint by default. You can extend this existing blueprint by adding the following properties to enable orchestration tracking:
203206

204207
1. Go to the [builder](https://app.getport.io/settings/data-model) page of your portal.
208+
205209
2. Select the `PagerDuty Incident` blueprint.
210+
206211
3. Click on the `{...} Edit JSON` button.
212+
207213
4. Add the following properties under the `properties` schema:
208214

209215
<details>
@@ -240,18 +246,23 @@ We need to configure integrations with Slack, Zoom, and Jira to enable the orche
240246
### Set up Slack App
241247

242248
1. [Create a Slack app](https://api.slack.com/start/quickstart#creating) and install it on a workspace.
249+
243250
2. [Add the following permissions](https://api.slack.com/quickstart#scopes) to the Slack app:
251+
244252
- **Create channel** (Required):
245253
- `channels:manage`
246254
- `groups:write`
247255
- `im:write`
248256
- `mpim:write`
257+
249258
- **Find a user with an email address** (Optional):
250259
- `users:read.email`
260+
251261
- **Invite users to channel** (Optional):
252262
- `channels:write.invites`
253263
- `groups:write.invites`
254264
- `mpim:write.invites`
265+
255266
- **Send messages** (Required):
256267
- `chat:write`
257268
- `chat:write.public`
@@ -261,6 +272,7 @@ We need to configure integrations with Slack, Zoom, and Jira to enable the orche
261272
:::
262273

263274
3. [Install the app in your Slack workspace](https://api.slack.com/quickstart#installing).
275+
264276
4. Navigate back to the **OAuth & Permissions page**. You will see an access token under **OAuth Tokens for Your Workspace** that you will use in the `SLACK_BOT_TOKEN` Port secret.
265277

266278
<img src='/img/self-service-actions/setup-backend/github-workflow/slack-app.png' width='70%' border="1px" />
@@ -270,12 +282,17 @@ We need to configure integrations with Slack, Zoom, and Jira to enable the orche
270282
Create a Server-to-Server OAuth app:
271283

272284
1. Go to [Zoom Marketplace](https://marketplace.zoom.us/).
285+
273286
2. Click **Develop → Build App** → select **Server-to-Server OAuth**.
287+
274288
3. Fill in the app details and make note of:
289+
275290
- **Account ID**
276291
- **Client ID**
277292
- **Client Secret**
293+
278294
4. Under **Scopes**, add:
295+
279296
- `meeting:write`
280297
- `meeting:read`
281298
- (optionally) `user:read`
@@ -285,7 +302,9 @@ Create a Server-to-Server OAuth app:
285302
### Set up Jira API access
286303

287304
1. Log in to your Jira instance.
305+
288306
2. Generate an API token:
307+
289308
- Go to [Atlassian Account Settings](https://id.atlassian.com/manage-profile/security/api-tokens)
290309
- Click **Create API token**
291310
- Copy the generated token (you will need this for the Port secret)
@@ -295,9 +314,13 @@ Create a Server-to-Server OAuth app:
295314
To add secrets to your portal:
296315

297316
1. Click on the `...` button in the top right corner of your Port application.
317+
298318
2. Click on **Credentials**.
319+
299320
3. Click on the `Secrets` tab.
321+
300322
4. Click on `+ Secret` and add the following secrets:
323+
301324
- `SLACK_BOT_TOKEN` - Your Slack bot token from the OAuth & Permissions page
302325
- `ZOOM_ACCOUNT_ID` - Your Zoom account ID
303326
- `ZOOM_CLIENT_ID` - Your Zoom client ID
@@ -317,8 +340,11 @@ We will create self-service actions that the AI agent can invoke to orchestrate
317340
This action creates a dedicated Slack channel for the incident.
318341

319342
1. Go to the [self-service](https://app.getport.io/self-serve) page of your portal.
343+
320344
2. Click on `+ New Action`.
345+
321346
3. Click on the `{...} Edit JSON` button.
347+
322348
4. Copy and paste the following JSON configuration:
323349

324350
<details>
@@ -368,8 +394,11 @@ This action creates a dedicated Slack channel for the incident.
368394
This action obtains a Zoom access token and then triggers the meeting creation.
369395

370396
1. Go back to the [self-service](https://app.getport.io/self-serve) page of your portal.
397+
371398
2. Click on `+ New Action`.
399+
372400
3. Click on the `{...} Edit JSON` button.
401+
373402
4. Copy and paste the following JSON configuration:
374403

375404
<details>
@@ -419,8 +448,11 @@ This action obtains a Zoom access token and then triggers the meeting creation.
419448
This action creates the actual Zoom meeting using the access token.
420449

421450
1. Go back to the [self-service](https://app.getport.io/self-serve) page of your portal.
451+
422452
2. Click on `+ New Action`.
453+
423454
3. Click on the `{...} Edit JSON` button.
455+
424456
4. Copy and paste the following JSON configuration:
425457

426458
<details>
@@ -495,8 +527,11 @@ This action creates the actual Zoom meeting using the access token.
495527
This action creates a Jira ticket to track the incident.
496528

497529
1. Go back to the [self-service](https://app.getport.io/self-serve) page of your portal.
530+
498531
2. Click on `+ New Action`.
532+
499533
3. Click on the `{...} Edit JSON` button.
534+
500535
4. Copy and paste the following JSON configuration:
501536

502537
<details>
@@ -608,8 +643,11 @@ This action creates a Jira ticket to track the incident.
608643
This action sends notification messages to Slack channels.
609644

610645
1. Go back to the [self-service](https://app.getport.io/self-serve) page of your portal.
646+
611647
2. Click on `+ New Action`.
648+
612649
3. Click on the `{...} Edit JSON` button.
650+
613651
4. Copy and paste the following JSON configuration:
614652

615653
<details>
@@ -677,8 +715,11 @@ This action sends notification messages to Slack channels.
677715
Now we will create the AI agent that orchestrates the incident response setup.
678716

679717
1. Go to the [AI Agents](https://app.getport.io/_ai_agents) page of your portal.
718+
680719
2. Click on `+ AI Agent`.
720+
681721
3. Toggle `Json mode` on.
722+
682723
4. Copy and paste the following JSON schema:
683724

684725
<details>
@@ -715,18 +756,24 @@ Now we will create the AI agent that orchestrates the incident response setup.
715756

716757
We will create automations to orchestrate the complete incident response workflow:
717758

718-
1. Trigger the AI agent when incidents are created
719-
2. Update the incident with Slack channel ID after creation
720-
3. Create Zoom meeting after obtaining access token
721-
4. Update incident with Zoom meeting link
722-
5. Update incident with Jira ticket link
759+
1. Trigger the AI agent when incidents are created.
760+
761+
2. Update the incident with Slack channel ID after creation.
762+
763+
3. Create Zoom meeting after obtaining access token.
764+
765+
4. Update incident with Zoom meeting link.
766+
767+
5. Update incident with Jira ticket link.
723768

724769
### Trigger Incident Orchestrator Agent
725770

726771
This automation invokes the Incident Orchestrator agent as soon as an incident is created.
727772

728773
1. Go to the [automations](https://app.getport.io/settings/automations) page of your portal.
774+
729775
2. Click on `+ Automation`.
776+
730777
3. Copy and paste the following JSON schema:
731778

732779
<details>
@@ -779,7 +826,9 @@ This automation invokes the Incident Orchestrator agent as soon as an incident i
779826
This automation updates the incident with the Slack channel ID after the channel has been created.
780827

781828
1. Go back to the [automations](https://app.getport.io/settings/automations) page of your portal.
829+
782830
2. Click on `+ Automation`.
831+
783832
3. Copy and paste the following JSON schema:
784833

785834
<details>
@@ -829,7 +878,9 @@ This automation updates the incident with the Slack channel ID after the channel
829878
This automation calls the Zoom API to create the meeting after obtaining the access token.
830879

831880
1. Go back to the [automations](https://app.getport.io/settings/automations) page of your portal.
881+
832882
2. Click on `+ Automation`.
883+
833884
3. Copy and paste the following JSON schema:
834885

835886
<details>
@@ -885,7 +936,9 @@ This automation calls the Zoom API to create the meeting after obtaining the acc
885936
This automation updates the incident with the created Zoom meeting link.
886937

887938
1. Go back to the [automations](https://app.getport.io/settings/automations) page of your portal.
939+
888940
2. Click on `+ Automation`.
941+
889942
3. Copy and paste the following JSON schema:
890943

891944
<details>
@@ -933,7 +986,9 @@ This automation updates the incident with the created Zoom meeting link.
933986
This automation updates the incident with the response of the created Jira ticket.
934987

935988
1. Go back to the [automations](https://app.getport.io/settings/automations) page of your portal.
989+
936990
2. Click on `+ Automation`.
991+
937992
3. Copy and paste the following JSON schema:
938993

939994
<details>
@@ -984,12 +1039,15 @@ Now let us test the complete incident orchestration workflow to ensure everythin
9841039
### Create a test incident
9851040

9861041
1. Go to your PagerDuty instance and create a new incident, or use Port's API to create a test incident entity.
1042+
9871043
2. Verify that the incident appears in your Port catalog.
9881044

9891045
### Verify AI agent orchestration
9901046

9911047
1. Check the AI agent's execution logs in the [AI Invocation](https://app.getport.io/_ai_invocationsEntity) page.
1048+
9921049
2. Verify that the agent has:
1050+
9931051
- Analyzed the incident severity and context
9941052
- Executed the appropriate actions based on urgency
9951053
- Created a Slack channel (for high/medium/critical incidents)
@@ -1000,18 +1058,23 @@ Now let us test the complete incident orchestration workflow to ensure everythin
10001058
### Verify incident updates
10011059

10021060
1. Go to your Port catalog and find the incident entity.
1061+
10031062
2. Check that the incident has been updated with:
1063+
10041064
- Slack channel ID
10051065
- Zoom meeting link (if applicable)
10061066
- Jira tracking ticket URL
1067+
10071068
3. Verify the links are functional and accessible.
10081069

10091070
<img src="/img/guides/incident-orchestration-port-entity.png" border="1px" width="80%" />
10101071

10111072
### Test in Slack
10121073

10131074
1. Go to your Slack workspace.
1075+
10141076
2. Verify that:
1077+
10151078
- A new channel was created with the incident identifier
10161079
- Notification messages were posted to the channel
10171080
- The channel contains relevant incident information

0 commit comments

Comments
 (0)