curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/webhooks/{id}/records \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/webhooks/{id}/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/webhooks/{id}/records"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"webhook_id": "<string>",
"view": {
"id": "<string>",
"webhook_id": "<string>",
"name": "<string>",
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"sort_key": "<string>",
"sort_dir": "asc",
"is_default": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"available_columns": [
"<string>"
],
"rows": [
{}
],
"count": 123
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Records received by one webhook, optionally through a saved view
Top-level alias: GET /admin/api/webhooks//records. Readable by any role. Only GET is routed here; other methods on this path fall through the webhook router to 405.
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/webhooks/{id}/records \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/webhooks/{id}/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/webhooks/{id}/records"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"webhook_id": "<string>",
"view": {
"id": "<string>",
"webhook_id": "<string>",
"name": "<string>",
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"sort_key": "<string>",
"sort_dir": "asc",
"is_default": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"columns": [
{
"key": "<string>",
"label": "<string>"
}
],
"available_columns": [
"<string>"
],
"rows": [
{}
],
"count": 123
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Path Parameters
Project id (UUID) belonging to the caller workspace.
Webhook id.
Query Parameters
Record-view id to shape and sort the rows. The view must belong to this webhook.
Row cap. Non-numeric or non-positive values fall back to 200; anything above 1000 is clamped to 1000.
1 <= x <= 1000Response
Rows for the webhook. Without a view, every row is the record meta columns plus its whole flattened payload and columns is the discovered key set. With a view, each row carries _id plus exactly the view columns (missing keys become null), sorted in SQL by the view sort key. available_columns is always the full discovered set.
The applied view in list shape (snake_case), or null.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Includes the meta columns _id, _received_at and _source.