|docs
Start Trial

List Event Enrichments

Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields.

Early Access

This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.

Retrieve a list of all Event Enrichments in the account.

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Query Parameters

limit?integer

The number of results per page.

offset?integer

Offset to start pagination search results.

include[]?array<>

Include additional details. Supported value is "privileges".

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Response Body

application/json

application/json

application/json

application/json

application/json

List Event Enrichment associations GET

Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. Associating an Event Orchestration or Service with an Event Enrichment allows for the enrichment to be evaluated when events are ingested for that Event Orchestration or Service <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Retrieve all items (Services or Event Orchestrations) associated with an Event Enrichment. If the API key lacks view access to an associated target, that item will not be returned in the results.

Mark an Event Enrichment as the account default PUT

Event Enrichments allow you to automatically add contextual data to events as they're ingested, so that relevant information is available throughout the event, alert, and incident lifecycle. By leveraging the Contextual Data Platform (CDP), you can define rules that extract values from events or query enrichment schemas to populate event fields. The default Event Enrichment gets applied to every Event Orchestration or Service that is not already associated to any other Event Enrichment <!-- theme: warning --> > ### Early Access > This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access. Mark a specific Event Enrichment as the account default. Set the request body to `default: null` to clear the current default.