curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/webhooks/create/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"is_active": true,
"events": "<unknown>"
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/webhooks/create/"
payload = {
"name": "<string>",
"url": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"is_active": True,
"events": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
slack_channel_id: '<string>',
slack_channel_name: '<string>',
is_active: true,
events: '<unknown>'
})
};
fetch('https://assess.praxicraft.com/api/v1/public/webhooks/create/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/webhooks/create/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
slack_channel_id: '<string>',
slack_channel_name: '<string>',
is_active: true,
events: '<unknown>'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/webhooks/create/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"is_active\": true,\n \"events\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "bright-harbor",
"kind": "https",
"url": "https://api.example.com/webhooks/praxicraft",
"secret_key": "whsec_abc123xyz",
"is_active": false,
"is_verified": false,
"events": [
"assessment.completed",
"candidate.passed",
"webhook.test"
],
"created_at": "2025-03-01T10:00:00Z",
"last_triggered_at": null,
"failure_count": 0,
"probe_consecutive_failures": 0,
"auto_paused_by_health": false,
"pending_delivery_count": 0
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Create webhook
Required scope:
webhooks:write
Registers a destination. HTTPS endpoints receive signed JSON (whsec_… shown once). Set kind to slack or teams (or paste a hooks.slack.com / webhook.office.com URL) to post a formatted chat message instead — no HMAC. After connecting Slack in the dashboard, you can omit url and pass slack_channel_id to post via chat.postMessage. New destinations start as is_active: false until a successful test ping.
Responses
| Status | When |
|---|---|
201 | Webhook created |
400 | Invalid URL or payload |
Authentication & rate limits (all endpoints)
| Status | Code | When |
|---|---|---|
401 | INVALID_API_KEY | Missing or invalid bearer token |
401 | EXPIRED_API_KEY | API key past its optional expires_at |
403 | INSUFFICIENT_SCOPE | API key lacks the required scope for this operation |
403 | IP_NOT_ALLOWED | Client IP is outside this key’s CIDR allowlist |
429 | RATE_LIMITED | Rate limit exceeded — plan-tiered reads/writes per organisation per hour |
curl --request POST \
--url https://assess.praxicraft.com/api/v1/public/webhooks/create/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"is_active": true,
"events": "<unknown>"
}
'import requests
url = "https://assess.praxicraft.com/api/v1/public/webhooks/create/"
payload = {
"name": "<string>",
"url": "<string>",
"slack_channel_id": "<string>",
"slack_channel_name": "<string>",
"is_active": True,
"events": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
slack_channel_id: '<string>',
slack_channel_name: '<string>',
is_active: true,
events: '<unknown>'
})
};
fetch('https://assess.praxicraft.com/api/v1/public/webhooks/create/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://assess.praxicraft.com/api/v1/public/webhooks/create/';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
slack_channel_id: '<string>',
slack_channel_name: '<string>',
is_active: true,
events: '<unknown>'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://assess.praxicraft.com/api/v1/public/webhooks/create/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"slack_channel_id\": \"<string>\",\n \"slack_channel_name\": \"<string>\",\n \"is_active\": true,\n \"events\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "bright-harbor",
"kind": "https",
"url": "https://api.example.com/webhooks/praxicraft",
"secret_key": "whsec_abc123xyz",
"is_active": false,
"is_verified": false,
"events": [
"assessment.completed",
"candidate.passed",
"webhook.test"
],
"created_at": "2025-03-01T10:00:00Z",
"last_triggered_at": null,
"failure_count": 0,
"probe_consecutive_failures": 0,
"auto_paused_by_health": false,
"pending_delivery_count": 0
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Organisation API key created in Assess → Developer → API Keys. Format: Bearer ct_live_<your-key> (live) or Bearer ct_test_<your-key> (test). Optional per-key CIDR allowlists return 403 IP_NOT_ALLOWED.
Body
Display name for this destination. Auto-generated if left blank.
80https = signed JSON. slack/teams = chat message (OAuth or Incoming Webhook).
https, slack, teams 3280List of event types this webhook subscribes to.
Response
Set to True after a successful test ping.
Failed health probes in a row; cleared on success. Endpoint pauses after threshold.
True when reachability probes auto-disabled this endpoint; used to queue deliveries while paused.
True for live destinations. False for test-mode destinations.
Display name for this destination. Auto-generated if left blank.
80https = signed JSON. slack/teams = chat message (OAuth or Incoming Webhook).
https, slack, teams 3280List of event types this webhook subscribes to.