curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{project_id}/destinations \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/destinations', 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/{project_id}/destinations"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"destinations": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"dataset_filter": "<string>",
"enabled": 0,
"created_at": "2023-11-07T05:31:56Z",
"timeout_seconds": 15,
"max_per_second": 500.05,
"max_concurrency": 50,
"previous_secret_expires_at": "2023-11-07T05:31:56Z",
"portal_id": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"paused_reason": "over_plan_limit",
"headers": [
{
"name": "<string>",
"secret": true,
"value": "<string>"
}
],
"auth": {
"type": "bearer",
"header": "<string>"
},
"transform": {},
"alert_url": "<string>",
"failing": true,
"consecutive_dead": 123,
"failing_since": "2023-11-07T05:31:56Z",
"last_failure": "<string>",
"auto_disabled_at": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"type": "webhook",
"config": {
"webhook_url": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"access_key_id": "<string>",
"queue_url": "<string>",
"fifo": true,
"project_id": "<string>",
"topic": "<string>",
"service_account_email": "<string>"
},
"secrets_set": [
"webhook_url"
]
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}List outbound destinations
Top-level alias: GET /admin/api/destinations. Readable by any role. Pages with ?limit and ?offset and returns total, limit and offset beside the array, which is unchanged (DX-6, #201).
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{project_id}/destinations \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/destinations', 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/{project_id}/destinations"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"destinations": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>",
"dataset_filter": "<string>",
"enabled": 0,
"created_at": "2023-11-07T05:31:56Z",
"timeout_seconds": 15,
"max_per_second": 500.05,
"max_concurrency": 50,
"previous_secret_expires_at": "2023-11-07T05:31:56Z",
"portal_id": "<string>",
"customer_id": "<string>",
"customer_name": "<string>",
"paused_reason": "over_plan_limit",
"headers": [
{
"name": "<string>",
"secret": true,
"value": "<string>"
}
],
"auth": {
"type": "bearer",
"header": "<string>"
},
"transform": {},
"alert_url": "<string>",
"failing": true,
"consecutive_dead": 123,
"failing_since": "2023-11-07T05:31:56Z",
"last_failure": "<string>",
"auto_disabled_at": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"type": "webhook",
"config": {
"webhook_url": "<string>",
"endpoint": "<string>",
"region": "<string>",
"bucket": "<string>",
"prefix": "<string>",
"access_key_id": "<string>",
"queue_url": "<string>",
"fifo": true,
"project_id": "<string>",
"topic": "<string>",
"service_account_email": "<string>"
},
"secrets_set": [
"webhook_url"
]
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}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.
Query Parameters
Page size, 1-1000. Omitted, the whole list up to 1000 rows (#201).
1 <= x <= 1000Rows to skip (#201).
x >= 0Response
Destinations of the project, newest first. Neither signing secret is included here, nor any secret header value or authentication credential (DLV-7): a secret header is listed by name only and auth by its type. dataset_filter is the stored JSON string (or null for every dataset). timeout_seconds, max_per_second and max_concurrency are null when the destination uses the default. type says how each destination delivers (webhook, slack, s3, sqs or pubsub) and config holds its settings without any credential (DLV-13).