Webhooks

Update a webhook endpoint

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.virlo.ai
  • URL: https://api.virlo.ai/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook endpoint ID (UUID) returned when it was created.

Request body

urlstring
descriptionstring
enabled_eventsstring[]

Event types this endpoint should receive. Replaces the whole list.

headersobject
is_activeboolean

Response

Webhook endpoint updated

idstring uuid required
team_idstring uuid required
urlstring required
descriptionstring nullable
enabled_eventsstring[] required
headersobject

Custom headers included on every delivery (secrets redacted in docs examples).

is_activeboolean required
status'active' | 'inactive' | 'disabled_by_system' required

Effective status: inactive when soft-deleted (is_active=false), disabled_by_system when the circuit breaker tripped, otherwise active.

consecutive_failuresnumber required
last_success_atstring nullable
last_failure_atstring nullable
created_bystring uuid nullable
created_atstring required
updated_atstring required

Example response

{
  "url": "https://hooks.example.com/virlo",
  "enabled_events": [
    "content_research_agent.run.completed"
  ],
  "headers": {}
}

Changes

No recorded changes to this operation across all 1 revision of this API.