Serval · AsyncAPI Specification

Serval Webhooks

Version

View Spec View on GitHub CompanyIT Service ManagementITSMHelp DeskWorkflow AutomationAI AgentsAccess ManagementEmployee SupportTicketingAsyncAPIWebhooksEvents

AsyncAPI Specification

Raw ↑
generated: '2026-07-21'
method: searched
source: https://docs.serval.com/sections/api-reference/webhook.md
spec_type: Webhooks   # documented webhook catalog; no published AsyncAPI document
overview: >
  Serval delivers HTTP POST push notifications to a user-configured endpoint when specific
  events occur in a workspace, for real-time integration with external systems and workflows.
delivery:
  transport: https
  method: POST
  envelope:
    id: string
    team_id: string
    timestamp: {seconds: int, nanos: int}
    data: object   # event-type-specific payload
events:
  - type: Copilot Status Change
    description: Fires when the help-desk copilot's status on a ticket thread changes.
    data:
      ticket_id: string
      thread_id: string
      thread_url: string
      status: string   # see status_values
      reason: string
      pending_workflows:
        - {workflow_id: string, workflow_name: string, arguments: string}
    status_values:
      - {value: WORKBENCH_STATUS_TYPE_APPROVAL_REQUIRED, meaning: Thread is awaiting approval}
      - {value: WORKBENCH_STATUS_TYPE_RESOLVED, meaning: Copilot has resolved the request}
      - {value: WORKBENCH_STATUS_TYPE_CANNOT_RESOLVE, meaning: Copilot believes it cannot resolve the request}
notes: >
  Webhook-triggered workflows shipped Nov 2025. Currently only the Copilot Status Change
  event triggers outbound webhook notifications. No AsyncAPI document is published, so this
  is captured as a webhook catalog (type: Webhooks).