Webhooks

Create a webhook endpoint (team-scoped)

post/v1/webhooks

Request

Base URL: https://api.virlo.ai
URL: https://api.virlo.ai/v1/webhooks
Auth: HTTP bearer

Request body

urlstring required

HTTPS destination URL

descriptionstring

enabled_eventsstring[] required

Event types this endpoint should receive

headersobject

Up to 5 custom headers to include on every delivery (e.g. Authorization: Bearer …)

is_activeboolean

Example request

{
  "url": "https://hooks.example.com/virlo",
  "description": "Production webhook",
  "enabled_events": [
    "orbit.run.completed",
    "comet.run.completed"
  ],
  "headers": {
    "X-MyApp-Token": "abc123"
  }
}

Response

Webhook endpoint created

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.