Request

Response

    review.created-1.0

    Event:
    review.created-1.0
    System:
    autodesk.construction.reviews
    Scope:
    project
    Trigger:
    When a review is created.

    Create a Webhook

    Request

    curl -X 'POST'\
         -v 'https://developer.api.autodesk.com/webhooks/v1/systems/autodesk.construction.reviews/events/review.created-1.0/hooks'\
         -H 'Content-Type: application/json'\
         -H 'authorization: Bearer bNU4P0trbQKNSzxWksLPTzSbbmUz'\
         -H 'region: US'\
         -d '{
                "callbackUrl": "https://d402-165-85-169-194.ngrok-free.app/callback",
                "scope": {
                    "project": "48f5f5b1-d5d2-49a3-b311-bcb90c0b60cb"
                },
                "hookAttribute": {
                    "projectId": "48f5f5b1-d5d2-49a3-b311-bcb90c0b60cb"
                }
            }'
    
    Show More
    • The region header is US by default, or you can specify the region API value you want to use, see Region for more details.

    Callback Payload

    Headers

    x-adsk-delivery-id
    string
    Payload delivery ID
    x-adsk-signature
    string
    Hash-signature of the payload using secret token as the key.
    It is prefixed with sha1hash=. Your callback endpoint can
    verify the signature to validate the integrity of the payload.

    Body Structure

    Expand all
    version
    string
    The version of the callback payload. This is always 1.0.
    resourceUrn
    string
    The UUID of the review that was created.
    hook
    object
    The object that contains the details about the webhook.
    system
    string
    The system that triggered the event. This is always autodesk.construction.reviews.
    event
    string
    The type of event that occurred. This is always review.created-1.0.
    hookId
    string
    The unique ID of the webhook. A hook ID is automatically assigned when the webhook is created.
    tenant
    string
    The project ID that the review was created in.
    callbackUrl
    string
    The callback URL specified when creating a webhook via a POST request.
    createdBy
    string
    The autodesk ID of the user that created the webhook.
    createdDate
    string
    The date and time when the webhook was created.
    lastUpdatedDate
    string
    The date and time when the webhook was last updated.
    creatorType
    string
    This indicates whether the webhook was created by a user. This is always O2User for 3-legged Tokens.
    hookAttribute
    object
    A user-defined JSON object that holds custom information about the webhook. The hookAttribute object is specified when the webhook is created.
    scope
    object
    This object identifies the extent of where the event is monitored. For example, if the scope is project, a notification is fired whenever a review is created for that project.
    urn
    string
    The URN of the webhook with the hook ID.
    status
    string
    This indicates if the webhook is active or not. Possible values: active and inactive.
    autoReactivateHook
    boolean
    Flag to enable the hook for the automatic reactivation flow. Please see Event Delivery Guarantees for more details.
    callbackWithEventPayloadOnly
    boolean
    Flag to determine the callback payload includes. false: the payload includes both event and webhook data. true: the payload includes only event data.
    __self__
    string
    The location of the webhook relative to /webhooks/v1/.
    payload
    object
    The object that contains details of the event that occurred.
    roundNum
    integer
    A new cycle of the review process created when the review is Sent Back to Initiator.
    sequenceId
    string
    The integer auto-increment ID displayed in the Review list after a Review is created.
    status
    string
    The status of the review. Possible values: OPEN and CLOSED.

    Example Body

    {
        "version": "1.0",
        "resourceUrn": "a4a3613c-c9dd-4e59-9d38-7b5a9857db9d",
        "hook": {
            "hookId": "afc16c9f-ddd5-470c-b4b9-dbab05775811",
            "tenant": "48f5f5b1-d5d2-49a3-b311-bcb90c0b60cb",
            "callbackUrl": "https://d402-165-85-169-194.ngrok-free.app/callback",
            "createdBy": "GTMMJRRXST63",
            "event": "review.created-1.0",
            "createdDate": "2024-09-05T06:02:40.925+00:00",
            "lastUpdatedDate": "2024-09-05T06:02:40.921+00:00",
            "system": "autodesk.construction.reviews",
            "creatorType": "O2User",
            "status": "active",
            "scope": {
                "project": "48f5f5b1-d5d2-49a3-b311-bcb90c0b60cb"
            },
            "hookAttribute": {
                "projectId": "48f5f5b1-d5d2-49a3-b311-bcb90c0b60cb"
            },
            "autoReactivateHook": true,
            "urn": "urn:adsk.webhooks:events.hook:afc16c9f-ddd5-470c-b4b9-dbab05775811",
            "callbackWithEventPayloadOnly": false,
            "__self__": "/systems/autodesk.construction.reviews/events/review.created-1.0/hooks/afc16c9f-ddd5-470c-b4b9-dbab05775811"
        },
        "payload": {
          "roundNum": 1,
          "sequenceId": "12",
          "status": "OPEN"
        }
    }
    
    Show More