Create an outbound destination
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{pid}/destinations \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"url": "<string>",
"datasetFilter": [
"<string>"
],
"enabled": true
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', url: '<string>', datasetFilter: ['<string>'], enabled: true})
};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/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/{pid}/destinations"
payload = {
"name": "<string>",
"url": "<string>",
"datasetFilter": ["<string>"],
"enabled": True
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"signing_secret": "<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>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Destinations
Create an outbound destination
Top-level alias: POST /admin/api/destinations. Write role required. The workspace-wide cap counts destinations with a non-null project_id and is checked before validation.
POST
/
admin
/
api
/
projects
/
{pid}
/
destinations
Create an outbound destination
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{pid}/destinations \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"url": "<string>",
"datasetFilter": [
"<string>"
],
"enabled": true
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', url: '<string>', datasetFilter: ['<string>'], enabled: true})
};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/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/{pid}/destinations"
payload = {
"name": "<string>",
"url": "<string>",
"datasetFilter": ["<string>"],
"enabled": True
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"signing_secret": "<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>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
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.
Body
application/json
Required string length:
1 - 80Absolute https URL. http and relative URLs are rejected. Normalized through the URL parser before storing.
CAMELCASE on create - the create validator reads datasetFilter, while PATCH reads dataset_filter. Omitted or null means every dataset.
Pattern:
^[A-Za-z][A-Za-z0-9_]{0,62}$Anything other than the literal false is treated as true.