Hubble Network · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hubble Platform Packet Webhooks API

6 actions 6 updates phrasing extends openapi/hubble-network-packet-webhooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Hubble Network's API. It is a proposal applied on top of the contract, not a document Hubble Network publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/org/{org_id}/webhooks'].get

$.paths['/v1/org/{org_id}/webhooks'].post

$.paths['/v1/org/{org_id}/webhooks/{webhook_id}'].delete

$.paths['/v1/org/{org_id}/webhooks/{webhook_id}'].patch

$.paths['/v1/org/{org_id}/webhooks/{webhook_id}/test'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubble Platform Packet Webhooks API
  version: 1.0.0
extends: openapi/hubble-network-packet-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/org/{org_id}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered webhooks
      effect: read
      questions:
      - Which webhook endpoints are set up to receive my packet data?
      - Where can I see all the webhooks registered for my organization?
      instructions:
      - text: List the registered webhooks for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show every packet webhook endpoint configured in org {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for packet data
      effect: write
      questions:
      - How do I get packet data pushed to my own server as it arrives?
      - Can I cap how many packets get batched into each webhook call when I set one up?
      instructions:
      - text: Register webhook URL {url} for packet data in organization {org_id}.
        slots:
          url: requestBody.url
          org_id: path.org_id
      - text: Create a webhook named {name} at {url} in org {org_id} with batches of at most {max_batch_size} packets.
        slots:
          name: requestBody.name
          url: requestBody.url
          org_id: path.org_id
          max_batch_size: requestBody.max_batch_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/webhooks/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook endpoint
      effect: destructive
      questions:
      - How do I stop a webhook from receiving any more packet traffic?
      - Can I remove a webhook endpoint I no longer use?
      instructions:
      - text: Delete webhook {webhook_id} in organization {org_id}.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
      - text: Stop sending packets to webhook {webhook_id} in org {org_id} by removing it.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/webhooks/{webhook_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's URL, name or batch size
      effect: write
      questions:
      - How do I point an existing webhook at a new URL?
      - Can I change the batch size on a webhook that's already registered?
      instructions:
      - text: Change the URL of existing webhook {webhook_id} in org {org_id} to {set_url}.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
          set_url: requestBody.set_url
      - text: Set existing webhook {webhook_id} in org {org_id} to batch at most {set_max_batch_size} packets.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
          set_max_batch_size: requestBody.set_max_batch_size
      - text: Rename webhook {webhook_id} in org {org_id} to {set_name}.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
          set_name: requestBody.set_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/webhooks/{webhook_id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test packet batch to a webhook
      effect: write
      questions:
      - How can I check that my webhook receives and authenticates packet deliveries correctly?
      - Is there a way to fire a sample packet batch at my endpoint without real device traffic?
      instructions:
      - text: Send a test packet batch to webhook {webhook_id} in organization {org_id}.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
      - text: Test delivery to webhook {webhook_id} in org {org_id} with an example packet.
        slots:
          webhook_id: path.webhook_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'