Hooks

Get a hook by ID

Changed on

Returns the full details of a single hook, including its configuration data and external references. Use this endpoint when you need the complete hook payload — for example, to inspect event subscription data or verify the hook URL before triggering events.

get/api/v3/hooks/{hookId}

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/hooks/{hookId}
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Path parameters

hookIdnumber required
Example:15473

Numeric ID of the hook to retrieve.

Response

Hook details retrieved successfully.

idnumber required

Unique numeric identifier for the hook.

namestring required

Display name of the hook, assigned when the hook is created.

teamIdnumber required

ID of the team this hook belongs to.

udidstring required

Globally unique string identifier for the hook. This value forms the last path segment of the hook URL.

themestring required

Hex color code used to visually identify the hook in the Fusion scenario builder.

editableboolean required

Indicates whether the hook configuration can be edited.

queueCountnumber required

Number of incoming events currently queued for processing.

queueLimitnumber required

Maximum number of events the queue can hold before new incoming events are rejected.

enabledboolean required

Indicates whether the hook is active and accepting incoming events.

goneboolean required

When true, the hook returns a 410 Gone response. This happens when the hook is no longer attached to an active scenario.

learningboolean required

Indicates whether the hook is currently in learning mode, where it captures payloads to infer its data structure.

typeNamestring required

Type name that identifies the hook's integration, e.g. 'custom-webhook', 'adobe-workfront' / 'adobe-workfront-legacy', or 'workfront-planning' / 'workfront-planning-legacy'.

dataobject required

Hook-specific configuration object. For Workfront hooks, this contains event subscription data. The shape varies by hook type.

scenarioIdnumber

ID of the scenario this hook is bound to. Returns null when the hook is not bound to a scenario.

urlstring

The public URL that external systems use to send events to this hook. The last path segment is the hook UDID.

priority'Low' | 'Medium' | 'High' required

Processing priority for the hook. Determines relative execution order when multiple hooks are queued. Possible values: Low, Medium, High.

detachedboolean required

Indicates whether the hook has been detached, meaning it no longer has an active subscription in the external system.

connectionIdnumber nullable

ID of the connection associated with this hook. Present when the hook was created using a connection.

automationobject nullable

Owner binding for this hook, projected from users.company_device.automation. Agent shape: {type:'agent', id, triggerId, versionId}. Scenario shape: {type:'scenario', id}. Null when the hook is not bound. The wire shape never includes the legacy automation.agentId — consumers always read automation.id.

Example response

{
  "id": 15473,
  "name": "My custom-webhook webhook",
  "teamId": 12685,
  "udid": "e902fmo3ho9f3w10uyx61qh80ncjdr20",
  "theme": "#C73A63",
  "queueLimit": 100000,
  "enabled": true,
  "typeName": "custom-webhook",
  "data": {},
  "scenarioId": 33723,
  "url": "https://hook.app.workfrontfusion.com/e902fmo3ho9f3w10uyx61qh80ncjdr20",
  "priority": "Low",
  "connectionId": 789
}

Changes

  • 08c52c47ab37Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • 15ef44a12969Revision changes
    • info

      endpoint added