Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hookdeck Bookmarks API

Save bookmarked events for quick replay and one-click testing during development. Bookmarks let your team capture canonical event payloads and trigger them on demand into any destination.

Hookdeck Bookmarks API is one of 17 APIs that Hookdeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bookmarks, Webhooks, and Event Gateways. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.hookdeck.com/2025-07-01.

7 operations 4 paths 14 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hookdeck.com/2025-07-01
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Hookdeck Bookmarks API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Bookmarks 7

A bookmark lets you conveniently store and replay a specific request.

GET
/bookmarks
Retrieve bookmarks
getBookmarks 11 params → 200400422
POST
/bookmarks
Create a bookmark
createBookmark body → 200400422
GET
/bookmarks/{id}
Retrieve a bookmark
getBookmark 1 param → 200404
PUT
/bookmarks/{id}
Update a bookmark
updateBookmark 1 param body → 200400404422
DELETE
/bookmarks/{id}
Delete a bookmark
deleteBookmark 1 param → 200404
GET
/bookmarks/{id}/raw_body
Get a bookmark raw body data
getBookmarkRawBody 1 param → 200404
POST
/bookmarks/{id}/trigger
Trigger a bookmark
triggerBookmark 1 param → 200400404422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Event (18 properties), Bookmark (10 properties), EventData (9 properties), ShortEventData (6 properties). Each schema is shown below with its type and property counts.

EventData
object
Event data if included
9 properties 7 required
EventStatus
string
ShortEventData
object
Request data
6 properties 5 required
BookmarkPaginatedResult
object
3 properties
Bookmark
object
10 properties 7 required
Event
object
18 properties 15 required
APIErrorResponse
object
Error response model
4 properties 3 required
Operators
object
6 properties
OrderByDirection
RawBody
object
1 property 1 required
EventArray
array
AttemptErrorCodes
string
Error code of the delivery attempt
DeletedBookmarkResponse
object
1 property 1 required
SeekPagination
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hookdeck-bookmarks-api-openapi.yml Raw ↑

Other APIs Hookdeck publishes across the network.

Hookdeck Connections API
Hookdeck Sources API
Hookdeck Destinations API
Hookdeck Events API
Hookdeck Requests API
Hookdeck Transformations API
Hookdeck Issues API
Hookdeck Metrics API
Hookdeck Integrations API
Hookdeck Notifications API
Hookdeck Attempts API
Hookdeck Bulk cancel events API