PagerDuty

Overview

Events

• New Incident

  Use this event to trigger a flow when an incident is triggered in your PagerDuty instance.

  Unless otherwise indicated, field type is text.

  NOTE: Do not use the New Incident Event Card and the Create Incident Action Card together in the same flow. By doing so, you create a circular reference.

  Options

  No options available.

  Output Fields

  Incident

  • Name: short description assigned to an incident
  • Incident Key: Parameter that identifies the incident to which a PagerDuty trigger event should be applied. An incident key helps prevent duplication of incidents.
  • Incident Number (number): numeric identifier automatically assigned to an incident in your PagerDuty instance
  • Incident ID: identifier that you can assign to an incident
  • Created At: date and time when an incident was created
  • Status: one of three states for an incident - triggered, acknowledged, or resolved
  • Urgency: feature that determines how a team is notified based on the criticality of an incident
    • High: requires immediate attention
    • Low: does not require prompt action
  • Type: type of integration that can be used to trigger an incident. Type can be incident or incident_reference.
  • URL: URL to view an incident in your PagerDuty instance

  Service

  • Name: name of a service (Example: application or component) against which incidents are opened
  • Service ID: unique identifier of a service
  • Type: type of integration for the service. Type can be service or service_reference.
  • URL: URL of an integrated application or component within your PagerDuty instance

  Escalation Policy

  • Escalation Policy ID: Identifier that is automatically assigned to an escalation policy. An escalation policy ensures the right people are notified at the right time when an incident occurs.
    
  • Type: Type of escalation policy. Type can be escalation_policy or escalation_policy_reference.
  • Summary: description of the escalation policy, including user and schedule targets
  • URL: URL to view an escalation policy within your PagerDuty instance

  Context

  • Execution ID: unique identifier for the execution of the Flow

Actions

• Create Incident

  Create a new incident within your PagerDuty instance.

  Unless otherwise indicated, field types are text.

  Required fields are indicated by a red asterisk on the Action Card.

  NOTE: Do not use the New Incident Event Card and the Create Incident Action Card together in the same Flow. By doing so, you can create a circular reference.

  Input Fields

  Incident

  • Service Key: key assigned to a service integration to send events to your PagerDuty instance and creates incidents on your service
  • Event Type: one of three options is required - trigger, acknowledge, or resolve
  • Description: short description assigned to an incident
  • Client: name of client application that is integrated with your PagerDuty instance
  • Client URL: URL of an integrated application or component

  Details

  Free-form details from an event in your PagerDuty instance.

  • Ping Time: time in milliseconds for PagerDuty’s monitoring tools to reach a host
  • Load Avg (number): average number of incidents per team

  Contexts

  Additional information such as graphs or images that can be attached to an incident. Only used for trigger events.

  • Type: Type of context; link and image are allowed types.
  • URL: URL for the context resource
  • Text: text for context asset that is attached to the incident

  Output Fields

  Incident Key: Parameter that identifies the incident to which a PagerDuty trigger event should be applied. An incident key helps prevent duplication of incidents.

• Create User

  Create a new user profile within your PagerDuty instance.

  Unless otherwise indicated, field types are text.

  Input Fields

  From

  • Email: email address of the person who is creating a new user profile in PagerDuty

  User

  • Type: Type of role that is assigned to the new user. user or user_reference.
  • Name: name of the new user
  • Email: new user’s email address
  • Timezone: timezone where the new user resides
  • Color: Color of schedule. A user has a color associated with their profile that is used in the on-call schedule for faster recognition.
  • Role: Role of the user. A role can be admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user or user.
    NOTE: User’s account must be assigned read_only_users to be able to set a user as read_only_user or read_only_limited_user. A user must be assigned permissions_service to be able to set a user as observer or restricted_access.
  • Job Title: job title of the new user
  • URL: URL for the user’s avatar
  • Description: bio informtion for new user’s account
  • Password: account password for a new user profile

  Output Fields

  User ID: unique identifier for new user profile that is generated by your PagerDuty instance

• Custom API Action

  Make a custom, authenticated HTTP call to PagerDuty.

  Options

  • Request Type (dropdown): use the appropriate request type depending on the endpoint/method
    • GET
    • POST
    • PUT
    • DELETE

  Input

  • Relative URL (text): Specify the relative URL as /api/v2/{insert_remaining_URL}. You can specify query parameters in the relative URL using “?”, or specify the query parameters as an object key pair in the Query input.
  • Query (object): Specify any additional query parameters that should be included in object format (key value pairs).
  • Headers (object): Specify any headers required in addition to authorization or content-type (these are already handled by this connector).
  • Body (object): Specify a request body in JSON format. Only available for POST and PUT requests.

  Output

  Response

  • Status Code (number): success or failure of your HTTP request. Here is a list of all status codes.

  • Headers (object): a detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will usually be a replica of the example below.

    Example: {"Content-type":"application/json"}

  • Body (object): data returned from your selected HTTP request (for example, the data from a GET request)

• Delete User

  Delete a user profile in your PagerDuty instance.

  Field type is text.

  Input Field

  Delete By

  • User ID: unique identifier of the user profile that you want to delete

  Output

  • Status Code (number): success or failure of your HTTP request. Here is a list of all status codes.

• Read Escalation Policy

  Access information on an escalation policy in your PagerDuty instance.

  Unless otherwise indicated, field types are text.

  Input Field

  Read By

  • Escalation Policy ID: unique identifer of the escalation policy you want to access

  Output Fields

  Escalation Policy

  • Name: name of the escalation policy that you requested
  • Type: Type of escalation policy. An escalation policy can have users or schedules as targets.
  • URL: URL to view an escalation policy within your PagerDuty instance

  List

  • Escalation Rules (list of objects):
    • Escalation Rule ID: unique identifier of an escalation rule within a policy
    • Escalation Delay: number of minutes that should pass before an incident escalates to the next level
  • Escalation Target (list of objects):
    • Target ID: identifier of the user or on-call schedule that is selected as a target for the policy
    • Target Type: type of target - user or on-call schedule
    • Target Name: name associated with the target
    • URL: URL to view the user profile or on-call schedule that is used as a target
  • Services (list of objects):
    • Service ID: unique identifier of a service for which an escalation policy is assigned
    • Name: name of a service (Example: application or component) for which an escalation policy is assigned
    • Type: type of integration for the service. A type can be service or service_reference.
    • URL: URL of an integrated application or component within your PagerDuty instance
  • Teams (list of objects):
    • Team ID: unique identifier for the team
    • Type: Types of roles that are assigned to members of the team. The options are teamorteam_reference`.

• Read Incident

  Access information on an incident in your PagerDuty instance.

  Unless otherwise indicated, field type is text.

  Input Fields

  Ready By

  • Incident Key: Parameter that identifies the incident to which a PagerDuty trigger event was applied. An incident key is assigned to an incident to help prevent duplication.

  Output Fields

  Incident

  • Name: short description assigned to an incident
  • Incident ID: identifier that you can assign to an incident
  • Incident Number (number): numeric identifier automatically assigned to an incident in your PagerDuty instance
  • Created At: date and time when an incident was created
  • Status: one of three states for an incident - Triggered, Acknowledged, or Resolved
  • Pending Actions (list of objects):
    • Type: Options that determine how incidents are dealt with once they are triggered - unacknowledge, escalate, resolve, or urgency_change.
    • At: The number of minutes after which a one of the four options on triggered incidents takes effect
  • Urgency: feature that determines how a team is notified based on the criticality of an incident
    • High: requires immediate attention
    • Low: does not require prompt action
  • Type: type of integration that can be used to trigger an incident. Type can be incident or incident_reference.
  • URL: URL to view an incident in your PagerDuty instance

  Service

  • Name: name of a service (Example: application or component) against which incidents are opened
  • Service ID: unique identifier of a service
  • Type: type of integration for the service. A type can be service or service_reference.
  • URL: URL of an integrated application or component within your PagerDuty instance

  Escalation Policy

  • Escalation Policy ID: Identifier that is automatically assigned to an escalation policy. An escalation policy ensures the right people are notified at the right time when an incident occurs.
    
  • Type: Type of escalation policy. Type can be escalation_policy or escalation_policy_reference.
  • Summary: description of the escalation policy, including user and schedule targets
  • URL: URL to view an escalation policy within your PagerDuty instance

  Last Status Change

  • Updated At: date and time of the latest update to an incident
  • Updated By ID: the identifier of the person who made the latest udpate to an incident
  • Type: the method by which an incident was updated - email or API
  • Name: the name of the service against which an incident was updated
  • URL: URL of the updated incident

• Read Service

  Access information on an application or component that is integrated with your PagerDuty instance.

  Unless otherwise indicated, field type is text.

  Input Fields

  Ready By

  • Service ID: unique identifier of a service

  Output Fields

  Service

  • Name: name of the service
  • Description: short description assigned to an application or component in your PagerDuty instance
  • Auto Resolve Timeout (number): Time in seconds that can pass before an incident is automatically resolved
  • Acknowledgement Timeout (number): Time in seconds that can pass before an acknowledged incident associated with this service is returned to a triggered state. This feature is turned off by default.
  • Created At: date and time when an incident was created against this service
  • Status: One of three states for an incident - active, warning, critical, maintenance, or disabled.

  Incident Urgency Rule

  Urgencies is a feature that allows you to customize how a team is notified based on the criticality of an incident.

  • Type: constant or use_support_hours
  • During Support Hours Type: Severity used to determine the urgency level. Values are one of the following:
    • critical
    • error
    • warning
    • info
  • During Support Hours Urgency:
    • notify until someone responds
    • notify but do not escalate
    • notify based on alert severity (based on settings within dynamic notifications)
  • Outside Support Hours Type: Severity used to determine the urgency level. Values are one of the following:
    • critical
    • error
    • warning
    • info
  • Outside Support Hours Urgency:
    • notify until someone responds
    • notify but do not escalate
    • notify based on alert severity (based on settings within dynamic notifications)

  List

  • Scheduled Actions (list of objects):
    • Type Event behavior that takes place against an incident -
      • Perform a trigger or resolve
      • Always trigger an alert
      • Always resolve an alert
    • At Type type of incident against which a specific action must be completed
    • At Name name of service for which an incident must be addressed in a specific manner
    • To Urgency severity that determines the type of action that must be completed

  Escalation Policy

  • Escalation Policy ID: Identifier that is automatically assigned to an escalation policy. An escalation policy ensures the right people are notified at the right time when an incident occurs.
    
  • Type: Type of escalation policy. An escalation policy can have users or schedules as targets.

• Read Team

  Access information on a team in your PagerDuty instance

  Field type is text.

  Input Field

  Read By

  • Team ID: unique identifer of the team profile you want to access

  Output Fields

  Team

  • Name: name given to the team whose information you requested
  • Description: short description assigned to the team
  • Type: Types of roles that are assigned to members of the team. A type can be team or team_reference.
  • URL: URL for the team profile in your PagerDuty instance

• Read User

  Access information on a user profile in your PagerDuty instance

  Unless otherwise indicated, field type is text.

  Input Fields

  User

  • User ID: unique identifier associated with the user profile which you are accessing

  Output Fields

  User

  • Name: name of the user
  • Email: user’s email address
  • Timezone: timezone where the user resides
  • URL: user profile’s unique URL in the web application
  • Role: Specific role within a user’s role type. Role can be admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, or user.
  • Description: information on resetting a password that is sent to a user along with the URL for password reset
  • Invitation Sent (true/false): date and time when an email for a password reset was sent to an email address associated with a new user
    
  • Job Title: job title of the user

• Search User

  Search for a user profile within your PagerDuty instance.

  Field type is text.

  Input Fields

  Search By

  • User Email: email address associated with the user profile for which you are searching

  Output Fields

  User

  • Name: name of the user
  • User ID: unique identifier associated with the user profile for which you are searching

• Update Incident

  Update an incident in your PagerDuty instance.

  Field type is text.

  Input Fields

  Update By

  • Incident ID: unique identifier of the incident that will be updated

  From

  • Email ID: email address of the user who will update the incident

  Incident

  • Type: type of integration that can be used to trigger an incident. Type can be incident or incident_reference.
  • Status: one of three states for an incident - acknowledged or resolved

  Output Fields

  There are no output fields.

• Update User

  Update a user profile within your PagerDuty instance.

  Field type is text.

  Input Fields

  Update By

  • User ID: unique identifier of the person who is updating a user profile in PagerDuty

  User

  • Type: Type of role that is assigned to the user. Role can be user or user_reference.
  • Name: name of the user
  • Email: user’s email address
  • Timezone: timezone where the user resides
  • Color: color of schedule. A user has a color associated with their profile that is used in the on-call schedule for faster recognition.
  • Role: Updated role within a user’s role type. Type can be admin, limited_user, observer, owner, read_only_user, restricted_access, read_only_limited_user, or user.
  • Job Title: updated job title of the user
  • URL: URL for the user’s avatar
  • Description: miscellaneous user information or bio
  • Password: account password for a user profile

  Output Fields

  There are no output fields.