Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When registering an endpoint, a name and a URL where notifications should be sent to must be provided. Furthermore, it must be indicated which of the following change types the integration endpoint should receive notifications for:

Change typeChangeType

Corresponding internal events

AssetChanged

AssetCreated, AssetDeleted, AssetExternalProccessingFinished, AssetFolderUpdated, AssetLocationStateUpdated, AssetMetadataUpdated, AssetProfilePublished, AssetSecurityUpdated, AssetUploadFinished

ComboValueChanged

ComboValueCreated, ComboValueDeleted, ComboValueMetadataUpdated, ComboValueSecurityUpdated

MetafieldChanged

MetafieldCreated, MetafieldDeleted, MetafieldMetadataUpdated, MetafieldSecurityUpdated

TreeValueChanged

TreeValueCreated, TreeValueDeleted, TreeValueMetadataUpdated, TreeValueSecurityUpdated

...

When using the API, make sure that your user has the required roles for the requested endpoint. In particular, the roles “Integration_Endpoints_View” and “Integration_Endpoints_CRUD” are required for a lot of the endpoints.

Note that it also is possible to get, retry, and purge failed messages with the API.

Info

Detailed Swagger documentation can be found at “/api-docs”.

...