Objects
Webhook
Represents a webhook that monitors the creation of a milestone on a component.
Fields
id* ID! non-null | The ID that uniquely identifies the webhook. |
componentId* ID! non-null | The ID of the component on which milestones are created. |
eventType* WebhookEventTypeEnum! non-null | The event type being monitored. Always MILESTONE_CREATED . |
callbackURL* String! non-null | The URL the event notification is sent to. |
filters* [String!] non-null | An optional array of filters (JsonPath format strings) for properties of the callback payload, which must match for the notification to be delivered. For example, you could set a filter to the name of a milestone ("$[?(@.data.milestone=='XXX')]" ). As a result, the system sends notifications only for the creation of the milestone with the specified name. Not for others. |
expiresOn | The date and time the webhook is set to expire, at which time the subscription is deleted. |
secretToken | An optional alphanumeric string that is used as a token to sign the callback payload. When secretToken is specified, the system uses it to generate a hash signature for each callback payload. It then sends the hash with the callback request using the header x-adsk-signature . To ensure that the request is authentic, subscribers must compute a hash using their token and verify that it matches the hash specified by x-adsk-signature . Forge Data Eventing uses an HMAC hexdigest to compute the hash. |
* Required
Where Used
Usage | Used By | Description |
---|---|---|
Field Of | Webhooks | Contains a list of Webhooks you have access to. |
Query By | webhook | Returns a webhook by ID. Currently, you can create a webhook to monitor the creation of milestones on a component. Once the webhook is created, the system sends a notification whenever a milestone is created on the specified component. The URL that the notification must be sent to and the ID of the component to monitor are specified by the argument passed to the mutation. |
Mutated By | createWebhook | Creates a Webhook. A Webhook is a way for Forge to send you a notification when an event that you are interested in occurs. For more information on Webhooks, see Using Webhooks with This API in the Developer’s Guide. |
Mutated By | updateWebhook | Updates a Webhook. For more information on Webhooks, see Using Webhooks with This API in the Developer’s Guide. |