Page Properties

hidden	true
id	DONE

Product Version
Report Note
Assignee

Resources & Remarks

Example by MZ: https://github.com/OPTIMALSYSTEMS/yuuvis-momentum-example-webhook

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.
Agnieszka	03 JUNE 2021	2021 Summer	rLANG
Antje	18 FEB 2022	2022 Spring	timeouts configuration
Antje	24 NOV 2022	2022 Winter	add webhookk type dms.request.objects.contents

...

HTTP Method

Webhook Type

Evaluation Target of the Predicate

Description

Affected Requests

GET

user.info

The tenant name of the user who sent the request.

Insert excerpt

	GET user.info (Webhook)
	GET user.info (Webhook)
nopanel	true

Authentication process

POST

dms.request.objects.upsert.storage-before

Objects provided by an import request body

Insert excerpt

	POST dms.request.objects.upsert.storage-before (Webhook)
	POST dms.request.objects.upsert.storage-before (Webhook)
nopanel	true

POST /api/dms/objects

POST /api/dms/objects/{objectId}
PATCH /api/dms/objects/{objectId}

POST /api/dms/objects/{objectId}/contents/file

POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore (as of 2022 Spring)

POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>

DELETE /api/dms/objects/{objectId}/tags/{name}
POST /api/dms/objects/{objectId}/tags/{name}/state/{state}
POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true

POST
as of 2021 Autumn

dms.request.objects.upsert.database-before

Enriched objects just before they are indexed

Insert excerpt

	POST dms.request.objects.upsert.database-before (Webhook)
	POST dms.request.objects.upsert.database-before (Webhook)
nopanel	true

POST /api/dms/objects

POST /api/dms/objects/{objectId}
PATCH /api/dms/objects/{objectId}

POST /api/dms/objects/{objectId}/contents/file

POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore (as of 2022 Spring)

POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>

DELETE /api/dms/objects/{objectId}/tags/{name}
POST /api/dms/objects/{objectId}/tags/{name}/state/{state}
POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true

POST

dms.request.update.metadata (deprecated)

Single object in the request body JSON list

Triggers upon metadata updates, before the JSON request body is evaluated and used to update the object.

Can be used to modify or validate the metadata, i.e., to facilitate role-based user authorization.

POST /api/dms/objects/{objectId}

PATCH /api/dms/objects/{objectId}

POST

dms.request.search

Incoming search queries

Insert excerpt

	POST dms.request.search (Webhook)
	POST dms.request.search (Webhook)
nopanel	true

POST /api/dms/objects/search

POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>

POST
(as of 2022 Winter)

dms.request.objects.contents

DMS object as stored in the system including metadata properties, content stream properties and options sections.

Insert excerpt

	POST dms.request.objects.contents (Webhook)
	POST dms.request.objects.contents (Webhook)
nopanel	true

Errors with a properly formatted body get the HTTP status code 404.

GET /api/dms/objects/{objectId}/contents/file
GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/file

GET /api/dms/objects/{objectId}/contents/renditions/text

GET /api/dms/objects/{objectId}/contents/renditions/pdf
GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/pdf

POST

dms.request.objects.delete

The active version of the object or the specific version that is to be deleted

Insert excerpt

	POST dms.request.objects.delete (Webhook)
	POST dms.request.objects.delete (Webhook)
nopanel	true

DELETE /api/dms/objects/{objectId}
DELETE /api/dms/objects

DELETE /api/dms/objects/{objectId}/versions/{versionNr}

POST

dms.response.objects

Objects within a list of objects that is to be returned to the user, i.e., in search queries

Insert excerpt

	POST dms.response.objects (Webhook)
	POST dms.response.objects (Webhook)
nopanel	true

POST /api/dms/objects

POST /api/dms/objects/{objectId}
PATCH /api/dms/objects/{objectId}
POST /api/dms/objects/{objectId}/contents/file

DELETE /api/dms/objects/{objectId}
DELETE /api/dms/objects

DELETE /api/dms/objects/{objectId}/tags/{name}

POST /api/dms/objects/{objectId}/tags/{name}/state/{state}
POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>
POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true
POST /api/dms/objects/search
POST /api/dms/objects/{objectId}/actions/move/contents/repositories/{repositoryId}
POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{repositoryId}

GET /api/dms/objects/{objectId}
GET /api/dms/objects/{objectId}/versions
GET /api/dms/objects/{objectId}/versions/{versionNr}

POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore (as of 2022 Spring)

DELETE /api/dms/objects/{objectId}/versions/{versionNr}

POST

dms.response.objects.insert

The final object after import

Insert excerpt

	POST dms.response.objects.insert (Webhook)
	POST dms.response.objects.insert (Webhook)
nopanel	true

POST /api/dms/objects

POST

dms.response.objects.update

The object after the update

Insert excerpt

	POST dms.response.objects.update (Webhook)
	POST dms.response.objects.update (Webhook)
nopanel	true

POST /api/dms/objects/{objectId}
PATCH /api/dms/objects/{objectId}

POST /api/dms/objects/{objectId}/contents/file

POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore (as of 2022 Spring)

POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>

DELETE /api/dms/objects/{objectId}/tags/{name}

POST /api/dms/objects/{objectId}/tags/{name}/state/{state}

POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true

POST

dms.response.objects.delete

The active version of the object or the specific version that is deleted

Insert excerpt

	POST dms.response.objects.delete (Webhook)
	POST dms.response.objects.delete (Webhook)
nopanel	true

DELETE /api/dms/objects/{objectId}
DELETE /api/dms/objects

DELETE /api/dms/objects/{objectId}/versions/{versionNr}

POST

dms.response.objects.search

Search result entry

Insert excerpt

	POST dms.response.objects.search (Webhook)
	POST dms.response.objects.search (Webhook)
nopanel	true

POST /api/dms/objects/search

...

Info

icon	false

Read on

Section

Column

width	25%

Preprocessing Metadata using Webhooks

Insert excerpt

	Preprocessing Metadata using Webhooks
	Preprocessing Metadata using Webhooks
nopanel	true

Keep reading

Column

width	25%

System Hooks

Insert excerpt

	System Hooks
	System Hooks
nopanel	true

Keep reading

Column

width	25%

Basic Use Case Flows

Insert excerpt

	System Hooks
	System Hooks
nopanel	true

Keep reading

Versions Compared

Old Version 1

New Version Current

Key

Read on

Preprocessing Metadata using Webhooks

System Hooks

Basic Use Case Flows

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Read on

Preprocessing Metadata using Webhooks

System Hooks

Basic Use Case Flows