ITSM webhook

Elimity Insights allows users to indicate necessary changes in the IAM data, like an AD user that should be deleted. Those change requests are stored by the Elimity Insights server. In addition, you can also integrate with your IT ticketing system by triggering a webhook for every new change request.

Configuring Elimity Insights

By default, the Elimity Insights server does not trigger any webhook when a new change request is created. To enable this feature, open the 'ITSM WEBHOOK' tab on the 'Advanced settings' page:

Request body format

The Elimity Insights server triggers your webhook by sending an HTTP POST request. We include detailed information about the change request in the HTTP request body. More specifically, the request body is a JSON object with the following properties:

Property
Type
Description

attributeTypeId

optional[string]

External identifier of the attribute type for which the assignment should change; present if and only if type is "attributeAssignment"

attributeTypeName

optional[string]

Name of the attribute type for which the assignment should change; present if and only if type is "attributeAssignment"

campaignName

optional[string]

Campaign name for the access review from which this change request originates; present if and only if type is "accessReviewSubmission"

comment

string

User-provided comment for the change request or access review

entity

optional[Entity]

Target entity for the change request; present if and only if type is "attributeAssignment" or "entityRemoval"

fromEntity

optional[Entity]

Entity from which the to-be-removed relationship starts; present if and only if type is "relationshipRemoval"

relationshipChanges

optional[list[RelationshipChange]]

Relationship changes requested in the access review, present if and only if type is "accessReviewSubmission"

requestedAt

string

Timestamp indicating when the change was requested

requestedBy

string

Email address of the change request creator

reviewCreatedBy

optional[string]

Email address of the access review creator; present if and only if type is "accessReviewSubmission"

rowRemovals

optional[list[RowRemoval]]

Row removals requested in the access review, present if and only if type is "accessReviewSubmission"

toEntity

optional[Entity]

Entity at which the to-be-removed relationship ends; present if and only if type is "relationshipRemoval"

type

string

One of "accessReviewSubmission", "attributeAssignment", "entityRemoval" or "relationshipRemoval"

value

optional[Value]

Describes current and requested values for the attribute assignment; only present if and only if type is "attributeAssignment"

The table below describes all properties for Entity objects:

Property
Type
Description

id

string

External identifier of the entity

name

string

Human-readable name of the entity

sourceId

number

Unique identifier of the entity's source

sourceName

string

Human-readable name of the entity's source

type

string

External identifier of the entity's type

All RelationshipChange objects have the following properties:

Property
Type
Description

columnEntity

Entity

Entity corresponding to the access review column for the to-be-changed relationship

comment

string

User-provided comment

operation

string

One of "add" or "remove"

rowEntity

Entity

Entity corresponding to the access review row for the to-be-changed relationship

The RowRemoval objects have a similar structure:

Property
Type
Description

comment

string

User-provided comment

entity

Entity

Entity corresponding to the to-be-removed access review row

Finally we also describe the Value objects:

Property
Type
Description

current

any

Current value of the to-be-changed assignment

requested

any

Requested value for the to-be-changed assignment

type

string

One of "boolean", "date", "dateTime", "number", "string" or "time"

Last updated