Skip to main content
GET
/
hooks
List Hooks
curl --request GET \
  --url https://api.posthook.io/v1/hooks \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "path": "<string>",
    "domain": "<string>",
    "data": {},
    "postAt": "2023-11-07T05:31:56Z",
    "status": "pending",
    "postDurationSeconds": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "attempts": 123,
    "failureError": "<string>",
    "tryAt": "2023-11-07T05:31:56Z",
    "wasNotified": true,
    "sequenceData": {
      "sequenceID": "<string>",
      "stepName": "<string>",
      "sequenceLastRunAt": "2023-11-07T05:31:56Z"
    }
  }
]
List your webhooks.

​
Usage Patterns

Common patterns for this endpoint include:
  • Dead Letter Queue: Process failures within a specific time window.
  • Bulk Retry: Batch retry failed hooks.
  • Auditing: Reconcile Posthook delivery logs with your internal records.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer
default:10
​
offset
integer
default:0
​
status
enum<string>
Available options:
pending,
posted,
failed,
retrying
​
postAtBefore
string<date-time>

Filter hooks scheduled before this timestamp

​
postAtAfter
string<date-time>

Filter hooks scheduled after this timestamp

​
createdAtBefore
string<date-time>

Filter hooks created before this timestamp

​
createdAtAfter
string<date-time>

Filter hooks created after this timestamp

Response

200 - application/json

List of hooks

​
id
string
​
path
string
​
domain
string
​
data
object
​
postAt
string<date-time>
​
status
enum<string>
Available options:
pending,
posted,
failed,
retrying
​
postDurationSeconds
number
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
attempts
integer
​
failureError
string
​
tryAt
string<date-time>
​
wasNotified
boolean
​
sequenceData
object