Hookdeck Admin REST API

Hookdeck Admin REST API

API version: 1.0.0

Auth

Bearer bearer | Bearer basic

Base URL

https://api.hookdeck.com/2024-09-01

Setup

1. Set Authorization header with your Bearer token
2. GET /issue-triggers -- verify access
3. POST /issue-triggers -- create first issue-triggers

Endpoints

101 endpoints across 14 groups. See references/api-spec.lap for full details.

issue-triggers

attempts

bookmarks

destinations

bulk

events

integrations

issues

requests

sources

notifications

teams

transformations

connections

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all issue-triggers?" -> GET /issue-triggers
• "Create a issue-trigger?" -> POST /issue-triggers
• "Get issue-trigger details?" -> GET /issue-triggers/{id}
• "Update a issue-trigger?" -> PUT /issue-triggers/{id}
• "Delete a issue-trigger?" -> DELETE /issue-triggers/{id}
• "List all attempts?" -> GET /attempts
• "Get attempt details?" -> GET /attempts/{id}
• "List all bookmarks?" -> GET /bookmarks
• "Create a bookmark?" -> POST /bookmarks
• "Get bookmark details?" -> GET /bookmarks/{id}
• "Update a bookmark?" -> PUT /bookmarks/{id}
• "Delete a bookmark?" -> DELETE /bookmarks/{id}
• "List all raw_body?" -> GET /bookmarks/{id}/raw_body
• "Create a trigger?" -> POST /bookmarks/{id}/trigger
• "List all destinations?" -> GET /destinations
• "Create a destination?" -> POST /destinations
• "Get destination details?" -> GET /destinations/{id}
• "Update a destination?" -> PUT /destinations/{id}
• "Delete a destination?" -> DELETE /destinations/{id}
• "Search retry?" -> GET /bulk/events/retry
• "Create a retry?" -> POST /bulk/events/retry
• "Search plan?" -> GET /bulk/events/retry/plan
• "Get retry details?" -> GET /bulk/events/retry/{id}
• "Create a cancel?" -> POST /bulk/events/retry/{id}/cancel
• "List all events?" -> GET /events
• "Get event details?" -> GET /events/{id}
• "List all raw_body?" -> GET /events/{id}/raw_body
• "Create a retry?" -> POST /events/{id}/retry
• "Search retry?" -> GET /bulk/ignored-events/retry
• "Create a retry?" -> POST /bulk/ignored-events/retry
• "Search plan?" -> GET /bulk/ignored-events/retry/plan
• "Get retry details?" -> GET /bulk/ignored-events/retry/{id}
• "Create a cancel?" -> POST /bulk/ignored-events/retry/{id}/cancel
• "List all integrations?" -> GET /integrations
• "Create a integration?" -> POST /integrations
• "Get integration details?" -> GET /integrations/{id}
• "Update a integration?" -> PUT /integrations/{id}
• "Delete a integration?" -> DELETE /integrations/{id}
• "Update a attach?" -> PUT /integrations/{id}/attach/{source_id}
• "Update a detach?" -> PUT /integrations/{id}/detach/{source_id}
• "List all issues?" -> GET /issues
• "List all count?" -> GET /issues/count
• "Get issue details?" -> GET /issues/{id}
• "Update a issue?" -> PUT /issues/{id}
• "Delete a issue?" -> DELETE /issues/{id}
• "List all requests?" -> GET /requests
• "Get request details?" -> GET /requests/{id}
• "List all raw_body?" -> GET /requests/{id}/raw_body
• "Create a retry?" -> POST /requests/{id}/retry
• "List all events?" -> GET /requests/{id}/events
• "List all ignored_events?" -> GET /requests/{id}/ignored_events
• "Search retry?" -> GET /bulk/requests/retry
• "Create a retry?" -> POST /bulk/requests/retry
• "Search plan?" -> GET /bulk/requests/retry/plan
• "Get retry details?" -> GET /bulk/requests/retry/{id}
• "Create a cancel?" -> POST /bulk/requests/retry/{id}/cancel
• "List all sources?" -> GET /sources
• "Create a source?" -> POST /sources
• "Get source details?" -> GET /sources/{id}
• "Update a source?" -> PUT /sources/{id}
• "Delete a source?" -> DELETE /sources/{id}
• "Create a custom_domain?" -> POST /teams/current/custom_domains
• "List all custom_domains?" -> GET /teams/current/custom_domains
• "Delete a custom_domain?" -> DELETE /teams/current/custom_domains/{domain_id}
• "List all transformations?" -> GET /transformations
• "Create a transformation?" -> POST /transformations
• "Get transformation details?" -> GET /transformations/{id}
• "Delete a transformation?" -> DELETE /transformations/{id}
• "Update a transformation?" -> PUT /transformations/{id}
• "List all executions?" -> GET /transformations/{id}/executions
• "Get execution details?" -> GET /transformations/{id}/executions/{execution_id}
• "List all connections?" -> GET /connections
• "Create a connection?" -> POST /connections
• "List all count?" -> GET /connections/count
• "Get connection details?" -> GET /connections/{id}
• "Update a connection?" -> PUT /connections/{id}
• "Delete a connection?" -> DELETE /connections/{id}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP