SG Ground Truth

GET /webhook/hooks/<record_uuid>

get_webhook_hooks_record_uuid

Returns the hook without its token. A well-formed uuid naming nothing answers 404 code 104, a segment that is not a uuid answers 404 code 103 with detail null.

API

Params

part value
<record_uuid> the id returned by POST /webhook/hooks

Sample requests

r = c.get(f"/webhook/hooks/{uuid}")
{ "data": { "id": "<uuid>", "url": "https://<host>/hook",
    "entity_types": { "Shot": { "create": [], "delete": [],
                                "update": ["sg_status_list", "description"] } },
    "status": "active", "projects": [1180], "num_deliveries": 0,
    "is_token_set": true, "name": "status watcher" },
  "links": { "self": "/api/v1/webhook/hooks/<uuid>" } }

Response codes

status when
200 found
404 code 104 a well-formed uuid that is not a hook. detail is hook: <uuid> not found
404 code 103 a segment that is not a uuid. detail is null

Edge cases

  • entity_types is returned with its action keys reordered. Compare it as a mapping, not as text.
  • The token is never returned. is_token_set is the only readable fact about it.
  • num_deliveries does not track the deliveries listing. On the probed site one hook reports 29 with zero records, and a hook with two records reports 0. What the counter counts is unmeasured; it does not count Webhook_Status_Change deliveries.

Every entry on this site is the output of a probe in probes/. The corpus is generated by running those probes against a live Flow Production Tracking site, not written from memory.

Not affiliated with or endorsed by Autodesk. Flow Production Tracking is their product; this is an independent record of how its REST API answers.