> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PagerDuty

> Reference for the Tracecat PagerDuty integration: registered actions, required secrets, expected inputs, and example workflow usage.

## Acknowledge event

Action ID: `tools.pagerduty.acknowledge_event`

Resolves an existing event in PagerDuty

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Input fields

<ParamField path="incident_key" type="string" required>
  Identifies the alert
</ParamField>

<ParamField path="service_key" type="string" required>
  The GUID of one of your Events API V2 integrations. This is the "Integration Key" listed on the Events API V2 integration's detail page.
</ParamField>

## Get all schedules

Action ID: `tools.pagerduty.get_all_schedules`

Get all the on-call schedules.

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Secrets

Required secrets:

* `pagerduty`: required values `PAGERDUTY_API_KEY`.

### Input fields

<ParamField path="query" type="string | null">
  Filters the result, showing only the records whose name matches the query.

  Default: `null`.
</ParamField>

## Get contact methods

Action ID: `tools.pagerduty.get_contact_methods`

Get contact methods in PagerDuty.

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Secrets

Required secrets:

* `pagerduty`: required values `PAGERDUTY_API_KEY`.

### Input fields

<ParamField path="user_id" type="string" required>
  The ID of the user.
</ParamField>

## Get incident data

Action ID: `tools.pagerduty.get_incident_data`

Show detailed information about an incident.

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Secrets

Required secrets:

* `pagerduty`: required values `PAGERDUTY_API_KEY`.

### Input fields

<ParamField path="incident_id" type="string" required>
  The ID of the incident.
</ParamField>

## Get incidents

Action ID: `tools.pagerduty.get_incidents`

List existing incidents.

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Secrets

Required secrets:

* `pagerduty`: required values `PAGERDUTY_API_KEY`.

### Input fields

<ParamField path="incident_key" type="string | null">
  Incident de-duplication key.

  Default: `null`.
</ParamField>

<ParamField path="since" type="string | null">
  The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month.

  Default: `null`.
</ParamField>

<ParamField path="status" type="string | null">
  Filter incidents by status.

  Default: `null`.
</ParamField>

<ParamField path="until" type="string | null">
  The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month.

  Default: `null`.
</ParamField>

## Get user notification rules

Action ID: `tools.pagerduty.get_user_notification_rules`

Get the notification rules of a PagerDuty user.

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Secrets

Required secrets:

* `pagerduty`: required values `PAGERDUTY_API_KEY`.

### Input fields

<ParamField path="user_id" type="string" required>
  The ID of the user.
</ParamField>

## Get users on-call

Action ID: `tools.pagerduty.get_users_on_call`

Get the users on-call.

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Secrets

Required secrets:

* `pagerduty`: required values `PAGERDUTY_API_KEY`.

### Input fields

<ParamField path="schedule_ids" type="array[string]" required>
  The ID of the schedule(s).
</ParamField>

<ParamField path="since" type="string | null">
  The start of the time range over which you want to search. Defaults to current time.

  Default: `null`.
</ParamField>

<ParamField path="until" type="string | null">
  The end of the time range over which you want to search. Defaults to current time.

  Default: `null`.
</ParamField>

## Resolve event

Action ID: `tools.pagerduty.resolve_event`

Resolves an existing event in PagerDuty

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Input fields

<ParamField path="incident_key" type="string" required>
  Identifies the alert
</ParamField>

<ParamField path="service_key" type="string" required>
  The GUID of one of your Events API V2 integrations. This is the "Integration Key" listed on the Events API V2 integration's detail page.
</ParamField>

## Trigger event

Action ID: `tools.pagerduty.trigger_event`

Trigger event to report a new problem

Reference: [https://developer.pagerduty.com/api-reference](https://developer.pagerduty.com/api-reference)

### Input fields

<ParamField path="service_key" type="string" required>
  The GUID of one of your Events API V2 integrations. This is the "Integration Key" listed on the Events API V2 integration's detail page.
</ParamField>

<ParamField path="severity" type="string" required>
  The perceived severity of the status the event is describing withrespect to the affected system.

  Allowed values: `critical`, `warning`, `error`, `info`.
</ParamField>

<ParamField path="source" type="string" required>
  The unique location of the affected system, preferably a hostname or FQDN.
</ParamField>

<ParamField path="summary" type="string" required>
  A brief text summary of the event, used to generate the summaries/titles of any associated alerts.
</ParamField>

<ParamField path="class" type="string">
  The class/type of the event.

  Default: `""`.
</ParamField>

<ParamField path="component" type="string">
  Component of the source machine that is responsible for the event.

  Default: `""`.
</ParamField>

<ParamField path="group" type="string">
  Logical grouping of components of a service.

  Default: `""`.
</ParamField>

<ParamField path="incident_key" type="string">
  Incident de-duplication key.

  Default: `null`.
</ParamField>