# mulesoft PagerDuty Connector - Full Documentation --- product: PagerDuty Connector version: 1.0 is-latest-version: true --- # PagerDuty Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for PagerDuty (PagerDuty Connector) enables you to connect to the PagerDuty API. PagerDuty Connector enables Mule applications to manage the entire incident lifecycle, including triggering, acknowledging, and resolving incidents, and configure core PagerDuty assets like Users, Schedules, and Escalation Policies directly from your Mule flows. For information about compatibility and fixed issues, refer to the PagerDuty Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The PagerDuty Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Code Builder or Anypoint Studio Before creating an app, you must have: - Credentials to access the PagerDuty target resource - Anypoint Platform - The latest versions of Anypoint Code Builder or Anypoint Studio ## Next Step After you complete the prerequisites, you’re ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) or [Anypoint Code Builder](https://docs.mulesoft.com/connectors/introduction/intro-config-use-acb). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [PagerDuty Connector Reference](https://docs.mulesoft.com/pagerduty-connector/latest/pagerduty-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: PagerDuty Connector version: 1.0 is-latest-version: true --- # PagerDuty Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Config Default configuration. #### Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | The connection types to provide to this configuration. | x | ||
Name | String | ID used to reference this configuration. | x | |
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
apiKey | String | API key used to authenticate requests. | x | |
baseUri | String | Base URI of the PagerDuty API. | x | |
TLS Configuration | Configures TLS. If using the HTTPS protocol, you must configure TLS. | |||
Reconnection | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
From | String | Email address of the user performing the operation. | ||
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
From | String | Email address of the user performing the operation. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
overflow | Boolean | If true, allow schedules to overflow to the next day. | false | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
From | String | Email address of the user performing the operation. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Null |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Null |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Null |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Null |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
time_zone | String | Time zone for the returned data. | ||
since | DateTime | Start of the time range to include. | ||
until | DateTime | End of the time range to include. | ||
overflow | Boolean | If true, allow schedules to overflow to the next day. | false | |
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
limit | Number | Maximum number of records to return. | ||
offset | Number | Offset to start returning records from. | ||
total | Boolean | If true, include the total record count. | false | |
query | String | Filters results by the supplied query. | ||
user_ids[] | Array of String | Filters results by user IDs. | ||
team_ids[] | Array of String | Filters results by team IDs. | ||
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
sort_by | Enumeration, one of:
| Sort order for results. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
limit | Number | Maximum number of records to return. | ||
offset | Number | Offset to start returning records from. | ||
total | Boolean | If true, include the total record count. | false | |
date_range | String | Time period to filter incidents. | ||
incident_key | String | Incident key to filter results. | ||
service_ids[] | Array of String | Filters results by service IDs. | ||
team_ids[] | Array of String | Filters results by team IDs. | ||
user_ids[] | Array of String | Filters results by user IDs. | ||
urgencies[] | Enumeration, one of:
| Urgency levels to filter by. | ||
time_zone | String | Time zone for the returned data. | ||
statuses[] | Enumeration, one of:
| Incident statuses to filter by. | ||
sort_by | Array of String | Fields to sort results by. | ||
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
since | String | Start time to filter incidents. | ||
until | String | End time to filter incidents. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
limit | Number | Maximum number of records to return. | ||
offset | Number | Offset to start returning records from. | ||
total | Boolean | If true, include the total record count. | false | |
query | String | Filters results by the supplied query. | ||
include[] | String | Additional fields to include in the response. | ||
time_zone | String | Time zone for the returned data. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
query | String | Filters results by the supplied query. | ||
limit | Number | Maximum number of records to return. | ||
offset | Number | Offset to start returning records from. | ||
total | Boolean | If true, include the total record count. | false | |
team_ids[] | Array of String | Filters results by team IDs. | ||
time_zone | String | Time zone for the returned data. | ||
sort_by | Enumeration, one of:
| Sort order for results. | ||
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
query | String | Filters results by the supplied query. | ||
team_ids[] | Array of String | Filters results by team IDs. | ||
limit | Number | Maximum number of records to return. | ||
offset | Number | Offset to start returning records from. | ||
total | Boolean | If true, include the total record count. | false | |
include[] | Enumeration, one of:
| Additional fields to include in the response. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Array of Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
From | String | Email address of the user performing the operation. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
overflow | Boolean | If true, allow schedules to overflow to the next day. | false | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
ID | String | Unique identifier of the resource. | x | |
body | Any | Request body. | ||
Config Ref | ConfigurationProvider | Name of the configuration to use to execute this component. | x | |
Target Variable | String | Name of the variable where the operation’s output will be placed. | ||
Target Value | String | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | #[payload] | |
Error Mappings | Array of Error Mapping | Set of error mappings. |
Type | Any |
Attributes Type | Any |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols | String | Comma-separated list of protocols enabled for this context. | ||
Enabled Cipher Suites | String | Comma-separated list of cipher suites enabled for this context. | ||
Trust Store | Configures the TLS truststore. | |||
Key Store | Configures the TLS keystore. | |||
Revocation Check | Configures a revocation checking mechanism. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the truststore. Mule resolves the path relative to the current classpath and file system. | ||
Password | String | Password used to protect the truststore. | ||
Type | String | Type of store. | ||
Algorithm | String | Encryption algorithm that the truststore uses. | ||
Insecure | Boolean | If |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the keystore. Mule resolves the path relative to the current classpath and file system. | ||
Type | String | Type of store. | ||
Alias | String | Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. | ||
Key Password | String | Password used to protect the private key. | ||
Password | String | Password used to protect the keystore. | ||
Algorithm | String | Encryption algorithm that the keystore uses. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities | Boolean | Which elements to verify in the certificate chain:
Verify only the last element in the certificate chain.
Verify all elements in the certificate chain. | ||
Prefer Crls | Boolean | How to check certificate validity:
Check the Certification Revocation List (CRL) for certificate validity.
Use the Online Certificate Status Protocol (OCSP) to check certificate validity. | ||
No Fallback | Boolean | Whether to use the secondary method to check certificate validity:
Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.
Do not use the secondary method to check certificate validity. | ||
Soft Fail | Boolean | What to do if the revocation server can’t be reached or is busy:
Avoid verification failure.
Allow the verification to fail. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url | String | URL of the OCSP responder. | ||
Cert Alias | String | Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path | String | Path to the CRL file. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment | Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. | ||
Reconnection Strategy | Reconnection strategy to use. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Blocking | Boolean | If | ||
Count | Number | How many reconnection attempts the Mule app can make. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Blocking | Boolean | If |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time | Number | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | ||
Time Unit | Enumeration, one of:
| Time unit for the Max Idle Time field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Source | Enumeration, one of:
| Error source type to map. | ||
Target | String | Target error type. | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. | ||
Buffer Size Increment | Number | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. | ||
Max Buffer Size | Number | Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects | Number | The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | ||
Buffer Unit | Enumeration, one of:
| Unit for the In Memory Objects field. |