Skip to main content
PATCH
Update Webhook
Updates an existing webhook configuration.

Overview

Update webhook settings including URL, subscribed events, custom headers, and active status. Only provided fields are updated; omitted fields remain unchanged.

Authentication

string
required
Bearer token with write:webhooks scope

Path Parameters

string
required
The webhook configuration ID (UUID v4)

Request Body

All fields are optional. Only provided fields are updated.
string
The HTTPS endpoint URL to receive webhook notifications. Maximum 2048 characters.
array
Array of event type strings to subscribe to:
  • "ANALYSIS_COMPLETED" - Analysis finished successfully
  • "ANALYSIS_FAILED" - Analysis processing failed
  • "PING" - Test event for connectivity
  • "CONVERSATION_COMPLETED" - The call finished and analysis is available
  • "CONVERSATION_FAILED" - A technical failure prevented the call
  • "CONVERSATION_STARTED" - A call attempt began
  • "CONVERSATION_RESCHEDULED" - A follow-up call attempt has been scheduled
  • "CONVERSATION_CANCELLED" - The conversation ended without completing
  • "SOURCING_COMPLETED" - Sourcing run finished with scored candidates
  • "SOURCING_FAILED" - Sourcing run terminated with an error
  • "ENRICH_COMPLETED" - Enrichment run completed
  • "ENRICH_FAILED" - Enrichment run terminated with an error
The five conversation events also accept their legacy spellings — "INTERVIEW_COMPLETED" and siblings — which register exactly the same subscription. See Event name vocabulary.
string
Human-readable name for the webhook. Maximum 255 characters.
string
Description of what this webhook is used for.
array
Custom headers to include in webhook requests. Maximum 50 headers.
This replaces all existing headers. Include all headers you want to keep.
boolean
Whether the webhook is active. Set to false to temporarily disable the webhook.

Response

Returns the updated webhook configuration.

Example Request

Example Response

Common Update Scenarios

Disable Webhook Temporarily

Update Event Subscriptions

Update Custom Headers

Error Responses

Get Webhook

View webhook configuration details

Reset Circuit

Reset circuit breaker for failed webhook