Request

Response

    dt.alert

    Event:
    dt.alert
    Service:
    adsk.tandem (Tandem)
    Scope:
    twinUrn
    Trigger:
    When a stream alert occurs.

    Create a Webhook

    Request

    curl -X 'POST'\
         -v 'https://developer.api.autodesk.com/webhooks/v1/systems/adsk.tandem/events/dt.alert/hooks'\
         -H 'Content-Type: application/json'\
         -H 'Authorization: Bearer eyjhbGCIOIjIuzI1NiISimtpZCI6...'\
         -d '{
                "callbackUrl": "http://bf067e05.ngrok.io/callback",
                "scope": {
                    "twinUrn": "urn:adsk.dtt:4n9u5YaVTpCgjigN5ER7KQ"
                }
            }'
    
    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 resource 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 adsk.tandem.
    event
    string
    The type of event that occurred. This is always dt.mutation.
    hookId
    string
    The unique ID of the webhook. A hook ID is automatically assigned when the webhook is registered.
    callbackUrl
    string
    The URL to which a POST request is sent when event occurs.
    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.
    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 twinUrn, a notification is fired when an element of the given twin is changed.
    twinUrn
    string
    The URN of the twin that triggered the event.
    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 that contains details of the event that occurred.
    timestamp
    string
    The time when element is modified.
    keys
    array
    Array of changed element ids.
    details
    object
    Additional details of the event.
    alertState
    number
    State of alert (0 = OK, 1 = Warning, 2 = Alert).
    attrName
    string
    Name of the parameter.
    attrUnit
    string
    Unit of the parameter.
    eventTimestamp
    number
    Epoch timestamp when the event occurred.
    previousState
    number
    Previous state of alert (0 = OK, 1 = Warning, 2 = Alert).
    spentSec
    number
    How long the alert has been in the current state, in seconds.
    streamId
    string
    ID of the stream.
    streamName
    string
    Name of the stream.
    substreamEncId
    string
    Qualified ID of stream parameter.
    thresholdLevel
    string
    Level of the threshold that was breached (e.g., lower:warning, upper:alert).
    thresholdValue
    number
    Value of the threshold that was breached.
    value
    number
    Current value of the parameter.

    Example Body

    {
      "version": "1.0",
      "resourceUrn": "urn:adsk.dtt:WtMe53OeTWuvLaCP4bvZkw",
      "hook": {
        "hookId": "134d1e8d-65c6-4595-b5b9-51122424033a",
        "tenant": "urn:adsk.dtt:4n9u5YaVTpCgjigN5ER7KQ",
        "callbackUrl": "http://bf067e05.ngrok.io/callback",
        "createdBy": "7HqqekpIbAfWIKu9G1Yxx9SOCX9rtn6p",
        "event": "dt.alert",
        "createdDate": "2025-02-13T03:11:50.294+0000",
        "system": "adsk.tandem",
        "creatorType": "Application",
        "status": "active",
        "scope": {
          "twinUrn": "urn:adsk.dtt:4n9u5YaVTpCgjigN5ER7KQ"
        },
        "urn": "urn:adsk.webhooks:events.hook:134d1e8d-65c6-4595-b5b9-51122424033a",
        "__self__": "/systems/adsk.tandem/events/dt.alert/hooks/134d1e8d-65c6-4595-b5b9-51122424033a"
      },
      "payload": {
        "timestamp": "2025-03-14T16:33:14.47Z",
        "details": {
          "alertState": 2,
          "attrName": "CO2",
          "attrUnit": "partsPerMillion",
          "eventTimestamp": 1769423401423,
          "previousState": 0,
          "spentSec": 0,
          "streamId": "AQAAAOSyKuTAZ06dmk53DSufPyoAAAAA",
          "streamName": "Test Stream",
          "substreamEncId": "z:KQ",
          "thresholdLevel": "upper:alert",
          "thresholdValue": 1000,
          "value": 1102
        }
      }
    }
    
    Show More