PTC Event Management Domain
The PTC Event Management domain provides access to the webhook subscription capabilities of Windchill. Webhook subscriptions enable Windchill to send event notifications to external systems when certain events or actions occur on object, folder, or context in Windchill through a webhook URL. The domain must be used along webhook to subscribe to events.
 |
• Subscription to events using the PTC Event Management domain is supported only for entities available in the following domains:
◦ PTC Product Management domain
◦ PTC Document Management domain
◦ PTC Data Administration domain
◦ PTC Change Management domain
◦ PTC CAD Document Management domain
◦ PTC Service Information Management domain
◦ PTC Parts List Management domain
◦ PTC Dynamic Document Management domain
|
The following table lists the significant OData entities available in the PTC Event Management domain. To see all the OData entities available in the PTC Event Management domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL.
|
Items
|
OData Entities
|
Description
|
|---|---|---|
|
Subscription to an event
|
EventSubscription
|
The EventSubscription entity represents the subscription to an event.
Specify the URL to the external system in the CallbackURL property. Notification of the event is sent to this URL.
To create a new subscription, use the POST operation. See the examples in the section Examples for the PTC Event Management Domain for more information on how to specify the payload while creating a subscription.
To delete a subscription, use the DELETE operation.
The EventSubscription entity has a navigation property SubscribedEvent that enables you to see the subscribed event.
|
|
Events
|
Event
|
The Event entity represents the Windchill events to which you can subscribe.
|
|
Subscription to events that occur on a Windchill object
|
EntityEventSubscription
|
The EntityEventSubscription entity represents the subscription to events that occur on a Windchill object.
The entity has a navigation property SubscribedOnEntity that enables you to see the entity instance for the subscription.
|
|
Subscription to events that occur on a container
|
EntityTypeInContainerEventSubscription
|
The EntityTypeInContainerEventSubscription entity represents the subscription to events that occur on a type of Windchill object in the specified context. For example, a Windchill product or library can serve as a context for a subscription.
The entity has a navigation property SubscribedOnContext that enables you to see the context of the subscription.
|
|
Subscription to events that occur on a folder
|
EntityTypeInFolderEventSubscription
|
The EntityTypeInFolderEventSubscription entity represents the subscription to events that occur on a type of Windchill object in the specified folder.
The entity has a navigation property SubscribedOnFolder that enables you to see the folder that serves as a context of the subscription.
|