Create a WebSocket trigger
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{project_id}/ws-triggers \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"url": "<string>",
"headers": {},
"subprotocols": [],
"connect_message": "<string>",
"conditions": [],
"mappings": [
{
"path": "<string>",
"key": "<string>"
}
],
"dataset": "<string>"
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
headers: {},
subprotocols: [],
connect_message: '<string>',
conditions: [],
mappings: [{path: '<string>', key: '<string>'}],
dataset: '<string>'
})
};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/ws-triggers', 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}/ws-triggers"
payload = {
"name": "<string>",
"url": "<string>",
"headers": {},
"subprotocols": [],
"connect_message": "<string>",
"conditions": [],
"mappings": [
{
"path": "<string>",
"key": "<string>"
}
],
"dataset": "<string>"
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"ws_trigger": {
"id": "<string>",
"name": "<string>",
"enabled": true,
"conditions": [
{
"path": "<string>",
"op": "equals",
"value": "<unknown>",
"equals": "<unknown>"
}
],
"mappings": [
{}
],
"dataset": "<string>",
"status": "connected",
"last_event_at": "<string>",
"last_error": "<string>",
"created_at": "<string>"
}
}{
"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>"
}{
"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
}WebSocket triggers
Create a WebSocket trigger
POST
/
admin
/
api
/
projects
/
{project_id}
/
ws-triggers
Create a WebSocket trigger
curl --request POST \
--url https://app.hookie.ai/admin/api/projects/{project_id}/ws-triggers \
--header 'Content-Type: application/json' \
--cookie hookie_session= \
--data '
{
"name": "<string>",
"url": "<string>",
"headers": {},
"subprotocols": [],
"connect_message": "<string>",
"conditions": [],
"mappings": [
{
"path": "<string>",
"key": "<string>"
}
],
"dataset": "<string>"
}
'const options = {
method: 'POST',
headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
headers: {},
subprotocols: [],
connect_message: '<string>',
conditions: [],
mappings: [{path: '<string>', key: '<string>'}],
dataset: '<string>'
})
};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/ws-triggers', 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}/ws-triggers"
payload = {
"name": "<string>",
"url": "<string>",
"headers": {},
"subprotocols": [],
"connect_message": "<string>",
"conditions": [],
"mappings": [
{
"path": "<string>",
"key": "<string>"
}
],
"dataset": "<string>"
}
headers = {
"cookie": "hookie_session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"ws_trigger": {
"id": "<string>",
"name": "<string>",
"enabled": true,
"conditions": [
{
"path": "<string>",
"op": "equals",
"value": "<unknown>",
"equals": "<unknown>"
}
],
"mappings": [
{}
],
"dataset": "<string>",
"status": "connected",
"last_event_at": "<string>",
"last_error": "<string>",
"created_at": "<string>"
}
}{
"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>"
}{
"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
sessionbearerAuthapiKey
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Headers
Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.
Required string length:
1 - 255Path Parameters
Body
application/json
Required string length:
1 - 80Must start with ws:// or wss://. Encrypted at rest with the rest of the connection config.
Connection headers. Encrypted; never returned.
Sent once on connect (e.g. a subscribe frame).
Frame filter; an empty array matches every frame. Validated on save (#165) and stored in the full {path, op, value} form.
Show child attributes
Show child attributes
Optional [{path,key}] field mappings, validated as a rule's are and applied to every matching frame the way a rule's are (#228): each picks a path out of the frame into a key of the event, which is what is filed into dataset or handed to the project's rules, and what default keeps when no rule matches (#284). The submission keeps the frame as it arrived. An empty array or null keeps the frame unchanged (identity).
Show child attributes
Show child attributes
Optional dataset every matching frame is stored in, as one record (after mappings). null or absent routes each frame through the project's mapping rules, and a frame none of them matches is stored whole, as one record, in the dataset default (#284) rather than kept as a submission with no record. Validated as a dataset name.