Hooks

Delete hook queue

Changed on

Deletes queued webhook events for the specified hook. Provide a specific set of ids via repeated params (?id=a&id=b, max 50), or ?all=true to clear the queue (optionally excluding ?except=a&except=b). Returns the ids that were deleted plus any that could not be (with a reason); if any id fails, the response status is 409 while the deletable rows are still removed. If a concurrent delete is already running for this hook the request is rejected with 423 (retry once it completes).

delete/api/v3/hooks/{hookId}/queue

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/hooks/{hookId}/queue
  • 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 whose queue to delete from.

Query parameters

idstring[]

Ids to delete. Comma-separated (id=1,2,3) or repeated (id=1&id=2). Mutually exclusive with all.

[
  "1",
  "2",
  "3"
]
allboolean

Delete every resource in scope. Mutually exclusive with id.

exceptstring[]

Ids to exclude. Only allowed together with all=true.

Response

All requested events were deleted. deleted lists them; failed is empty.

deletedstring[] required

Ids that were deleted.

Changes

  • 9eea20e77721Revision changes
    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • warning

      deleted the query request parameter excludeId

    • info

      added the new optional query request parameter except

    • info

      added the non-success response with the 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 the not_found enum value from the // response property for the response status

    • info

      removed the not_found enum value from the // response property for the response status

    • info

      removed the processing enum value from the // response property for the response status

    • info

      removed the processing enum value from the // response property for the response status

  • 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