Skip to content

Create Webhook Endpoint

POST /webhook-endpoints

Admin, not member: creating one opens a public URL into the workspace.

FieldTypeNotes
agent_idstring (uuid)required—
slugstringrequiredmin length 1 max length 100
http_methodPOST | GET | PUToptionalDefault "POST".
verificationhmac_sha256 | shared_token | noneoptionalDefault "hmac_sha256".
secretstring | nulloptionalmin length 16 max length 400
prompt_templatestringrequiredmin length 1
input_templateobject | nulloptional—
session_key_templatestring | nulloptionalmax length 400
persona_slug_templatestring | nulloptionalmax length 400
subject_templateSubjectTemplate | nulloptional—
response_modeasync | sync | callback | ackoptionalDefault "async".
response_pathstring | nulloptionalmax length 400
callback_urlstring | nulloptionalmax length 2000
event_kindstring | nulloptionalmax length 60
rate_limit_per_minuteintegeroptionalDefault 60. min 1 max 10000
coalescingCoalescingConfigoptional—
unverified_ackbooleanoptionalDefault false.
is_activebooleanoptionalDefault true.
StatusDescriptionBody
201Successful ResponseWebhookEndpointView
422Validation ErrorHTTPValidationError

The body shows the fields the schema always carries. Which combination is legal is a service rule the schema cannot express, so read the description above before copying this.

Terminal window
curl -X POST https://your-deployment.example.com/webhook-endpoints \
-H "Authorization: Bearer $COBRE_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"agent_id": "0190a2f4-0000-7000-8000-000000000000",
"slug": "string",
"prompt_template": "string"
}'
FieldTypeNotes
idstring (uuid)required—
agent_idstring (uuid)required—
slugstringrequired—
http_methodPOST | GET | PUTrequired—
verificationhmac_sha256 | shared_token | nonerequired—
secret_setbooleanrequired—
rotation_activebooleanrequired—
secret_overlap_untilstring (date-time) | nullrequired, nullable—
prompt_templatestringrequired—
input_templateobject | nullrequired, nullable—
session_key_templatestring | nullrequired, nullable—
persona_slug_templatestring | nullrequired, nullable—
subject_templateobject | nullrequired, nullable—
response_modeasync | sync | callback | ackrequired—
response_pathstring | nullrequired, nullable—
callback_urlstring | nullrequired, nullable—
event_kindstring | nullrequired, nullable—
rate_limit_per_minuteintegerrequired—
coalescingobjectrequired—
unverified_ackbooleanrequired—
call_countintegerrequired—
is_activebooleanrequired—
created_atstring (date-time)required—