Request

Response

    model.publish

    Event:
    model.publish
    System:
    adsk.c4r (Cloud Workshared Revit)
    Scope:
    folder
    Trigger:
    When a Revit Cloud Worksharing model is queued or when processing starts.

    Create a Webhook

    Request

    curl -X 'POST'\
         -v 'https://developer.api.autodesk.com/webhooks/v1/systems/adsk.c4r/events/model.publish/hooks'\
         -H 'Content-Type: application/json'\
         -H 'authorization: Bearer bNU4P0trbQKNSzxWksLPTzSbbmUz'\
         -d '{
                "callbackUrl": "http://bf067e05.ngrok.io/callback",
                "scope": {
                    "folder": "urn:adsk.wipprod:fs.folder:co.s424tpjyS_yYBs5ozch94g"
                }
            }'
    
    Show More

    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
    Version of the callback payload. Always 1.0
    resourceUrn
    string
    URN of the model that triggered the event.
    hook
    object
    Object containing details of the webhook.
    system
    string
    System triggering the event. Always adsk.c4r.
    event
    string
    Type of event that occurred. Always model.publish
    hookid
    string
    Unique id of the webhook. A hookid is automatically assigned when you register the webook.
    tenant
    string
    Deprecated.
    callbackUrl
    string
    URL that a POST request is sent to when a model is queued or when processing starts.
    createdBy
    string
    Id of the user or application that registered the webhook.
    createdDate
    string
    Date and time the webhook was registered.
    creatorType
    string
    Indicates whether the webhook was created by a user or application. Possible values are Application and O2User.
    hookAttribute
    object
    User defined JSON object that holds custom information about the webhook. The hookAttribute object is specified when you register the webhook.
    scope
    object
    Object identfying the extent to where the event is monitored. For example, if the scope is folder a notification is fired whenever a model within the folder being monitored or a sub-folder under it is queued or when processing starts.
    folder
    string
    URI of the folder being monitored.
    urn
    string
    URI of the webhook.
    status
    string
    Indicates if the webhook is active or not. Possible values are active and inactive.
    __self__
    string
    Location of the webhook relative to /webhooks/v1/.
    payload
    object
    Object containing details of the event that occured.
    state
    string
    Reason why the notification was triggered. Possible values are PUBLISHING_PENDING and PUBLISHING_IN_PROGRESS.

    Note: There is no PUBLISHING_COMPLETE state. Use the dm.version.added event to recieve notifications when publishing is finished.
    projectId
    string
    BIM 360 Id of the project containing the model.
    parentFolder
    string
    BIM 360 Id of the folder containing the model.
    modelGuid
    string
    Revit Cloud Worksharing model identifier.
    projectGuid
    string
    Revit Cloud Worksharing project identifier.
    modelVersion
    integer
    Version of the Revit Cloud Worksharing model.
    episodeGuid
    object
    Id of the most recent Revit Cloud Worksharing episode.

    Example

    {
      "version": "1.0",
      "resourceUrn": "urn:adsk.wipprod:dm.lineage:4qsCZu1nRNWvGThBdoHlvw",
      "hook": {
        "system": "adsk.c4r",
        "event": "model.publish",
        "hookId": "ce4cc990-31c4-11e8-94f2-73ce66fa9735",
        "tenant": "urn:adsk.wipprod:fs.folder:co.s424tpjyS_yYBs5ozch94g",
        "callbackUrl": "http://bf067e05.ngrok.io/callback",
        "createdBy": "************",
        "createdDate": "2017-09-22T02:38:32.341+0000",
        "creatorType": "Application",
        "hookAttribute": {
          "myfoo": 34,
          "projectId": "someURN",
          "myobject": {
            "nested": true
          }
        },
        "scope": {
          "folder": "urn:adsk.wipprod:fs.folder:co.s424tpjyS_yYBs5ozch94g"
        },
        "urn": "urn:adsk.webhooks:events.hook:1fcd3e30-9f3f-11e7-951f-0fd5337ed5ce",
        "status": "active",
        "__self__": "/systems/adsk.c4r/events/model.publish/hooks/ce4cc990-31c4-11e8-94f2-73ce66fa9735"
      },
      "payload": {
        "state" : "PUBLISHING_PENDING",
        "projectId" : "b.65ddd035-a4a1-4e15-9db8-1b2b4a410bcf",
        "parentFolder" : "urn:adsk.wipprod:fs.folder:co.s424tpjyS_yYBs5ozch94g",
        "modelGuid" : "0f29fb84-ea94-46a9-9488-ca9f88d58461",
        "projectGuid" : "9a1ea050-ab00-440a-9b64-520b38eb1dd2",
        "modelVersion" : 15,
        "episodeGuid" : "617e8d76-1dbc-40be-86c7-c1b8643495af"
      }
    }
    
    Show More