Hooks

List hooks

Changed on

Returns a paginated list of hooks in the caller organization that the requesting user is permitted to view.

get/api/v3/hooks

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/hooks
  • 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

Query parameters

propertystring[] 
Property filters. Can be repeated and are AND-ed together.

Allowed fields:
- id
- name
- teamId
- udid
- type
- enabled
- gone
- typeName
- scenarioId
- priority
- detached
- automationType
- automationId

Supported operators:
- ==  (equals)
- !=  (not equals)
- >   (greater than)
- >=  (greater than or equal)
- <   (less than)
- <=  (less than or equal)
- ~   (case-insensitive regex match)

Special cases:
- field           → field exists
- !field          → field does not exist

[
  "teamId==3849"
]
startstring

Paging cursor. Must correspond to "orderby" field and used only when it is set.

limitinteger

Maximum number of items to return. Must be a positive integer. Range 1–200.

orderbystring
Example:+id

Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, teamId, udid, type, priority.

Response

Paginated list of hooks matching the provided search criteria.

Example response

{
  "_page": {
    "orderby": "+id",
    "start": "123",
    "next": "124",
    "count": 100
  },
  "_links": {
    "next": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304",
    "page": "/v3/{{resource}}{?orderby,start,limit,property,type}"
  },
  "items": [
    {
      "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

  • 7c7767c7a45fRevision changes
    • warning

      deleted the query request parameter teamId

    • info

      added the required property // to the response with the status