Secret shown once.
POST /v1/webhook_endpoints
- Scope
webhooks:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”
Delivery format. Existing deliveries retain their captured format after endpoint changes.formatstringone of
native,workos· default"native"urlstring (uri) Requiredeventsarray of string Requiredmin items 1
versionstringenabledboolean
Responses
Section titled “Responses”- 201 OK WebhookSecret
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/webhook_endpoints" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://app.acme.com/callback", "events": [ "user.signed_in" ]}'const response = await fetch("https://api.ohauthcat.com/v1/webhook_endpoints", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "url": "https://app.acme.com/callback", "events": [ "user.signed_in" ] }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/webhook_endpoints", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "url": "https://app.acme.com/callback", "events": [ "user.signed_in", ], },)data = response.json(){ "endpoint": { "format": "native", "id": "whep_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "object": "webhook_endpoint", "url": "https://app.acme.com/callback", "events": [ "user.signed_in" ], "version": "1.0", "enabled": true, "created_at": "2026-01-15T09:30:00Z" }, "secret": "sk_test_example", "previous_secret_expires_at": "2026-01-15T09:30:00Z"}