{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Events
Track events
POST
/
v1
/
events
{
"success": true,
"data": {},
"error": {
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
},
"metadata": {
"timestamp": "<string>",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}{
"success": false,
"data": {},
"error": {
"code": "invalid_api_key",
"message": "<string>",
"param": "<string>",
"details": [
{
"param": "<string>",
"message": "<string>"
}
]
},
"metadata": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>"
}
}Authorizations
An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.