Forge Webhooks API allows applications to listen to Forge events, and receive notifications when they occur.
Webhooks eliminate the need to keep on polling to check for the occurrence of events. Instead, register webhooks for the events you want to monitor. On the occurrence of a registered event, you are notified through a POST request sent to the Callback URL you specified at the time you registered the webhook. For example, you can register a webhook to call back a URL when a file is modified within a project or folder.
There are four key elements to a webhook:
- The target service of interest.
- The events from the target service to subscribe. Please check Supported Events section for additional information.
- The callback URL i.e. URL where the Webhooks service will notify when the events occur.
- The Scope i.e. the domain of the data for which this webhook was created.