event_enrichments

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

Overview

Name	event_enrichments
Type	Resource
Id	pagerduty.enrichment.event_enrichments

Fields

The following fields are returned by SELECT queries:

get

The Event Enrichment object.

Name	Datatype	Description
id	string	ID of the Event Enrichment.
name	string	The name of the Event Enrichment.
associated_event_orchestrations	integer	The number of Event Orchestrations associated with this Event Enrichment.
associated_services	integer	The number of Services associated with this Event Enrichment.
created_at	string (date-time)	The date/time the Event Enrichment was created.
created_by	object	Reference to the user that created the Event Enrichment.
description	string	A description of this Event Enrichment's purpose.
is_default	boolean	Indicates whether this Event Enrichment is the account default.
privileges	object	Details about the read/update permissions of the current user for this Event Enrichment. Only present when include[]=privileges is requested.
self	string (url)	The API show URL at which the object is accessible.
team	object	Reference to the team that owns this Event Enrichment.
updated_at	string (date-time)	The date/time the Event Enrichment was last updated.
updated_by	object	Reference to the user that last updated the Event Enrichment.

list

A list of Event Enrichments for the account.

Name	Datatype	Description
id	string	ID of the Event Enrichment.
name	string	The name of the Event Enrichment.
associated_event_orchestrations	integer	The number of Event Orchestrations associated with this Event Enrichment.
associated_services	integer	The number of Services associated with this Event Enrichment.
created_at	string (date-time)	The date/time the Event Enrichment was created.
created_by	object	Reference to the user that created the Event Enrichment.
description	string	A description of this Event Enrichment's purpose.
is_default	boolean	Indicates whether this Event Enrichment is the account default.
privileges	object	Details about the read/update permissions of the current user for this Event Enrichment. Only present when include[]=privileges is requested.
self	string (url)	The API show URL at which the object is accessible.
team	object	Reference to the team that owns this Event Enrichment.
updated_at	string (date-time)	The date/time the Event Enrichment was last updated.
updated_by	object	Reference to the user that last updated the Event Enrichment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id	include[]	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 /><!-- 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 details of a specific Event Enrichment.<br />
list	select		limit, offset, include[]	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 /><!-- 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 a list of all Event Enrichments in the account.<br />
create	insert	event_enrichment		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 /><!-- 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 />Create a new Event Enrichment.<br />
update	update	id, event_enrichment		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 /><!-- 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 />Update an existing Event Enrichment.<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 /><!-- 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 />Delete a specific Event Enrichment. The user must have "Delete" privileges for both the Event Enrichment and all of its associated items.<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.
include[]	array	Include additional details. Supported value is "privileges".
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.

SELECT examples

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.<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 details of a specific Event Enrichment.<br />

SELECT
id,
name,
associated_event_orchestrations,
associated_services,
created_at,
created_by,
description,
is_default,
privileges,
self,
team,
updated_at,
updated_by
FROM pagerduty.enrichment.event_enrichments
WHERE id = '{{ id }}' -- required
AND include[] = '{{ include[] }}'
;

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 /><!-- 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 a list of all Event Enrichments in the account.<br />

SELECT
id,
name,
associated_event_orchestrations,
associated_services,
created_at,
created_by,
description,
is_default,
privileges,
self,
team,
updated_at,
updated_by
FROM pagerduty.enrichment.event_enrichments
WHERE limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND include[] = '{{ include[] }}'
;

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 /><!-- 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 />Create a new Event Enrichment.<br />

INSERT INTO pagerduty.enrichment.event_enrichments (
event_enrichment
)
SELECT 
'{{ event_enrichment }}' /* required */
RETURNING
event_enrichment
;

Manifest

# Description fields are for documentation purposes
- name: event_enrichments
props:
  - name: event_enrichment
    value:
      id: "{{ id }}"
      name: "{{ name }}"
      description: "{{ description }}"
      is_default: {{ is_default }}
      associated_services: {{ associated_services }}
      associated_event_orchestrations: {{ associated_event_orchestrations }}
      team:
        id: "{{ id }}"
        type: "{{ type }}"
        self: "{{ self }}"
      privileges:
        permissions:
          - "{{ permissions }}"
      created_at: "{{ created_at }}"
      created_by:
        id: "{{ id }}"
        type: "{{ type }}"
        self: "{{ self }}"
      updated_at: "{{ updated_at }}"
      updated_by:
        id: "{{ id }}"
        type: "{{ type }}"
        self: "{{ self }}"
      self: "{{ self }}"

UPDATE examples

update

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 /><!-- 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 />Update an existing Event Enrichment.<br />

UPDATE pagerduty.enrichment.event_enrichments
SET 
event_enrichment = '{{ event_enrichment }}'
WHERE 
id = '{{ id }}' --required
AND event_enrichment = '{{ event_enrichment }}' --required
RETURNING
event_enrichment;

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 /><!-- 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 />Delete a specific Event Enrichment. The user must have "Delete" privileges for both the Event Enrichment and all of its associated items.<br />

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