Autodesk Platform Services Webhooks API
The APS Webhooks API is used to enable you to subscribe to a callback service and receive notifications when one of the following events occur:
- A new change request has been created.
- A new item has been created.
All webhook endpoints can be used once the callback URL is set up. Below is a quick summary of this workflow:
- Identify the events for which you want to receive notifications.
- Use
POST /systems/:system/events/:event/hooks
endpoint to subscribe to an event’s notification. - A notification is sent each time the subscribed-to event occurs.
After you subscribe to event notifications, you may obtain a list of all subscriptions or delete a subscription.
You may use any method you choose to run wenhooks APIs, for example:
- Using a command line prompt on your computer
- Postman
Supported events
There are two supported events which are published from Upchain using APS Webhook API.
Event type | Description |
---|---|
cr.created |
Notification is sent when a new change request is created. |
item.created |
Notification is sent when a new item is created. |
*.created |
Notification is sent when either a new change request or new item is created. |
Supported system IDs
The system ID uniquely identifies the environment in which the hook will be created. It is determined by your application URL.
Application URL | System ID |
---|---|
live.upchain.net | adsk.upchain.live |
eap.upchain.net 1 | adsk.upchain.eap |
1 EAP stands for Early Access Program. This is an environment where you may test out new features before they are released to the wider public. Click to learn more.