event_enrichment_associations

Creates, updates, deletes, gets or lists an event_enrichment_associations resource.

Overview

Name	event_enrichment_associations
Type	Resource
Id	pagerduty.enrichment.event_enrichment_associations

Fields

The following fields are returned by SELECT queries:

list

A list of associations for the Event Enrichment.

Name	Datatype	Description
id	string	The ID of the associated Service or Event Orchestration.
self	string (url)	The API show URL at which the associated resource is accessible.
summary	string	The name of the associated Service or Event Orchestration.
type	string	The type of the associated resource. (service_reference, event_orchestration_reference)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	id	association_type, limit, offset	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.<br /><br />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<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />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.<br />
create	insert	id, associations		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.<br /><br />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<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Add new associations between an Event Enrichment and Services or Event Orchestrations.<br />
delete	delete	id		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.<br /><br />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<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Remove associations between an Event Enrichment and Services or Event Orchestrations.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the Event Enrichment.
association_type	string	Filter associations by type. Either "service" or "event_orchestration".
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.

SELECT examples

list

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.<br /><br />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<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />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.<br />

SELECT
id,
self,
summary,
type
FROM pagerduty.enrichment.event_enrichment_associations
WHERE id = '{{ id }}' -- required
AND association_type = '{{ association_type }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
;

INSERT examples

create

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.<br /><br />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<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Add new associations between an Event Enrichment and Services or Event Orchestrations.<br />

INSERT INTO pagerduty.enrichment.event_enrichment_associations (
associations,
id
)
SELECT 
'{{ associations }}' /* required */,
'{{ id }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: event_enrichment_associations
props:
  - name: id
    value: "{{ id }}"
    description: Required parameter for the event_enrichment_associations resource.
  - name: associations
    value:
      - type: "{{ type }}"
        id: "{{ id }}"
        summary: "{{ summary }}"
        self: "{{ self }}"

DELETE examples

delete

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.<br /><br />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<br /><br /><!-- theme: warning --><br /><br />> ### Early Access<br />> This API is in Early Access and may change at any time. Contact your PagerDuty account team to request access.<br /><br />Remove associations between an Event Enrichment and Services or Event Orchestrations.<br />

DELETE FROM pagerduty.enrichment.event_enrichment_associations
WHERE id = '{{ id }}' --required
;