/programs/{program_id}/frameworks/{framework_id}/auth/webhooksUpdate OptiTech Auth webhook configuration
Updates the webhook configuration for the specified framework's OptiTech Auth integration. Webhooks notify an external endpoint when auth events occur, such as user creation or sign-in.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/auth/webhooks" \
-X PUT \
-H "Authorization: Bearer $OPTITECH_API_KEY"optitech optitech-auth config webhook update --enabledParameters
program_idThe OptiTech program ID
framework_idThe OptiTech framework ID
Request body
1 required Required: enabled.
enabledwebhook_urlenabled_eventstimeout_secondsmin: 1, max: 10
Response
200Returns the updated webhook configuration
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.