Request

Response

    bid.created-1.0

    Event:
    bid.created-1.0
    System:
    autodesk.construction.bc (BuildingConnected)
    Scope:
    companyId
    Trigger:
    When a bid revision is created.

    Create a Webhook

    Request

    curl -X 'POST'\
         -v 'https://developer.api.autodesk.com/webhooks/v1/systems/autodesk.construction.bc/events/bid.created-1.0/hooks'\
         -H 'Content-Type: application/json'\
         -H 'authorization: Bearer bNU4P0trbQKNSzxWksLPTzSbbmUz'\
         -d '{
                "callbackUrl": "http://bf067e05.ngrok.io/callback",
                "scope": {
                    "companyId": "my-company-id"
                },
                "hookAttribute": {
                    "myfoo": 34,
                    "officeId": "office-id",
                    "myobject": {
                      "nested": true
                    }
                },
            }'
    
    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
    The version of the callback payload. This is always 1.0.
    resourceUrn
    string
    The URN of the model that triggered the event.
    hook
    object
    The object that contains the details about the webhook.
    system
    string
    The system that triggered the event. This is always autodesk.construction.bc.
    event
    string
    The type of event that occurred. This is always opportunity.status.updated-1.0.
    hookId
    string
    The unique ID of the webhook. A hook ID is automatically assigned when the webhook is registered.
    tenant
    string
    This is deprecated.
    callbackUrl
    string
    The URL to which a POST request is sent when a model is queued or when processing starts.
    createdBy
    string
    The ID of the user or application that registered the webhook.
    createdDate
    string
    The date and time when the webhook was registered.
    creatorType
    string
    This indicates whether the webhook was created by a user or an application. This is always O2User.
    hookAttribute
    object
    A user-defined JSON object that holds custom information about the webhook. The hookAttribute object is specified when the webhook is registered.
    scope
    object
    This object identifies the extent of where the event is monitored. For example, if the scope is companyId, a notification is fired whenever a comment is created for an opportunity for that company.
    urn
    string
    The URN of the webhook.
    status
    string
    This indicates if the webhook is active or not. Possible values: active and inactive.
    __self__
    string
    The location of the webhook relative to /webhooks/v1/.
    payload
    object
    The object containing details of the event that occurred.
    bidId
    string
    The ID of the bid that was created.

    Example Body

    {
      "version": "1.0",
      "resourceUrn": "5a832c12abaedd954831e5d7",
      "hook": {
        "hookId": "a228fb60-106b-11e8-9774-490cff0c6aae",
        "tenant": "my-company-id",
        "callbackUrl": "http://bf067e05.ngrok.io/callback",
        "createdBy": "594206015caedd954831e5b8",
        "event": "bid.created-1.0",
        "createdDate": "2018-02-13T03:11:50.294+0000",
        "system": "autodesk.construction.bc",
        "creatorType": "O2User",
        "status": "active",
        "scope": {
          "companyId": "my-company-id"
        },
        "hookAttribute": {
          "myfoo": 34,
          "officeId": "office-id",
          "myobject": {
            "nested": true
          }
        },
        "urn": "urn:adsk.webhooks:events.hook:a228fb60-106b-11e8-9774-490cff0c6aae",
        "__self__": "/systems/autodesk.construction.bc/events/bid.created-1.0/hooks/a228fb60-106b-11e8-9774-490cff0c6aae"
      },
      "payload": {
        "bidId": "5a832c12abaedd954831e5d7"
      }
    }
    
    Show More