Hubble Network Packet Webhooks API

The Packet Webhooks API from Hubble Network — 3 operation(s) for packet webhooks.

Documentation GitHub OpenAPI

Business capability

Webhook & Event Subscription Management BC-4270.80

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/org/{org_id}/webhooks Register a webhook for packet data · Create a Webhook Endpoint #

Ask an LLM

“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?”

Tell an agent

Register webhook URL {url} for packet data in organization {org_id}.

Create a webhook named {name} at {url} in org {org_id} with batches of at most {max_batch_size} packets.

GET /v1/org/{org_id}/webhooks List registered webhooks · List Registered Webhooks #

Ask an LLM

“Which webhook endpoints are set up to receive my packet data?”

“Where can I see all the webhooks registered for my organization?”

Tell an agent

List the registered webhooks for organization {org_id}.

Show every packet webhook endpoint configured in org {org_id}.

PATCH /v1/org/{org_id}/webhooks/{webhook_id} Change a webhook's URL, name or batch size · Update a Webhook Endpoint #

Ask an LLM

“How do I point an existing webhook at a new URL?”

“Can I change the batch size on a webhook that's already registered?”

Tell an agent

Change the URL of existing webhook {webhook_id} in org {org_id} to {set_url}.

Set existing webhook {webhook_id} in org {org_id} to batch at most {set_max_batch_size} packets.

DELETE /v1/org/{org_id}/webhooks/{webhook_id} Delete a webhook endpoint · Delete a Webhook Endpoint #

Ask an LLM

“How do I stop a webhook from receiving any more packet traffic?”

“Can I remove a webhook endpoint I no longer use?”

Tell an agent destructive · confirm first

Delete webhook {webhook_id} in organization {org_id}.

Stop sending packets to webhook {webhook_id} in org {org_id} by removing it.

POST /v1/org/{org_id}/webhooks/{webhook_id}/test Send a test packet batch to a webhook · Send a Test Webhook #

Ask an LLM

“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?”

Tell an agent

Send a test packet batch to webhook {webhook_id} in organization {org_id}.

Test delivery to webhook {webhook_id} in org {org_id} with an example packet.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hubble-network:hubble-network-packet-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Hubble Platform Packet Webhooks API
  description: The Hubble platform is built API-first.
  version: 1.0.0
servers:
- url: https://api.hubble.com
  description: Production
security:
- BearerAuth: []
tags:
- name: Packet Webhooks
paths:
  /v1/org/{org_id}/webhooks:
    post:
      tags:
      - Packet Webhooks
      operationId: create-webhook-endpoint
      x-criticality: high
      summary: Create a Webhook Endpoint
      description: 'Register an endpoint that can receive webhook events for packet data.


        **Required Scope:** `write-webhooks`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  $ref: '#/components/schemas/webhookURL'
                max_batch_size:
                  $ref: '#/components/schemas/webhookMaxBatchSize'
                name:
                  $ref: '#/components/schemas/webhookName'
      responses:
        '200':
          description: A registered webhook endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhookWithSecret'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    get:
      tags:
      - Packet Webhooks
      operationId: list-registered-webhooks
      x-criticality: high
      summary: List Registered Webhooks
      description: 'Retrieve a list of registered webhooks.


        **Required Scope:** `read-webhooks`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      responses:
        '200':
          description: A list of registered webhook endpoints
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      $ref: '#/components/schemas/basicWebhook'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
  /v1/org/{org_id}/webhooks/{webhook_id}:
    patch:
      tags:
      - Packet Webhooks
      operationId: update-webhook-endpoint
      x-criticality: high
      summary: Update a Webhook Endpoint
      description: 'Update certain fields of a webhook endpoint.


        **Required Scope:** `write-webhooks`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/webhookIdPathParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                set_name:
                  $ref: '#/components/schemas/webhookName'
                set_max_batch_size:
                  $ref: '#/components/schemas/webhookMaxBatchSize'
                set_url:
                  $ref: '#/components/schemas/webhookURL'
      responses:
        '200':
          description: The updated webhook endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/basicWebhook'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
    delete:
      tags:
      - Packet Webhooks
      operationId: delete-webhook-endpoint
      x-criticality: high
      summary: Delete a Webhook Endpoint
      description: 'Delete a webhook endpoint.


        **Required Scope:** `write-webhooks`

        Delete a webhook endpoint so that it will stop receiving traffic.'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/webhookIdPathParam'
      responses:
        '200':
          description: The webhook has been deleted
          content:
            application/json:
              schema:
                type: object
                description: an empty object for now
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
  /v1/org/{org_id}/webhooks/{webhook_id}/test:
    post:
      tags:
      - Packet Webhooks
      operationId: test-webhook-endpoint
      x-criticality: high
      summary: Send a Test Webhook
      description: 'Send an example packet batch to the configured webhook URL to test webhook delivery

        (connectivity, authentication, and response handling). Uses the same request shape as

        live delivery (JSON packet batch plus `HTTP-X-HUBBLE-TOKEN` when a secret is configured).

        The example packet is ephemeral and is not persisted after one attempt.


        **Required Scope:** `write-webhooks`'
      parameters:
      - $ref: '#/components/parameters/orgIdPathParam'
      - $ref: '#/components/parameters/webhookIdPathParam'
      responses:
        '200':
          description: Result of the test webhook delivery attempt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/testWebhookResponse'
        '400':
          $ref: '#/components/responses/ErrorBadRequest'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '500':
          $ref: '#/components/responses/ErrorInternalServer'
components:
  parameters:
    orgIdPathParam:
      name: org_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/orgId'
      description: Your organization ID
    webhookIdPathParam:
      name: webhook_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/webhookId'
  schemas:
    webhookId:
      type: string
      description: An identifier for a webhook
    errorResponse:
      type: object
      properties:
        code:
          type: integer
          description: The HTTP status code
        description:
          type: string
          description: 'A description for the error.

            For user errors, we attempt to be as descriptive as possible to help with diagnosing the issue.

            For internal errors, the error description is only indicates that a retry should occur but we log the full error so that we can diagnose it.

            Error descriptions can change over time and should not be programmed against.

            '
        name:
          type: string
          enum:
          - Bad Request
          - Unauthorized
          - Not Found
          - Too Many Requests
          - Internal Server Error
          description: '`name` is a short name for the error.

            '
    basicWebhook:
      type: object
      allOf:
      - $ref: '#/components/schemas/legacyWebhook'
      - type: object
        properties:
          webhook_id:
            $ref: '#/components/schemas/webhookId'
          org_id:
            $ref: '#/components/schemas/orgId'
          name:
            $ref: '#/components/schemas/webhookName'
    webhookName:
      type: string
      description: A name/description for a webhook
      maxLength: 250
    legacyWebhook:
      type: object
      properties:
        url:
          $ref: '#/components/schemas/webhookURL'
        max_batch_size:
          $ref: '#/components/schemas/webhookMaxBatchSize'
    testWebhookResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the webhook endpoint returned a successful HTTP status code
        status_code:
          type: integer
          description: HTTP status code returned by the webhook endpoint, if a response was received
        error:
          type: string
          description: Error details when the test delivery failed
    webhookWithSecret:
      type: object
      allOf:
      - $ref: '#/components/schemas/basicWebhook'
      - type: object
        properties:
          secret:
            $ref: '#/components/schemas/webhookSecret'
    webhookURL:
      type: string
      description: A webhook url
      maxLength: 2000
    orgId:
      type: string
      format: uuid
      description: The ID for an organization
    webhookMaxBatchSize:
      type: integer
      description: The maximum number of packets that Hubble will batch into one webhook request
      default: 100
      minimum: 10
      maximum: 1000
    webhookSecret:
      type: string
      description: 'A confidential, unique string generated for your webhook endpoint to validate that the request came from Hubble.

        Hubble will send this token in the HTTP header `HTTP-X-HUBBLE-TOKEN` when making HTTPS requests to your endpoint.

        '
  responses:
    ErrorNotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 404
            description: The requested resource was not found.
            name: Not Found
    ErrorInternalServer:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 500
            description: An unknown error has occurred.
            name: Unknown
    ErrorBadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          example:
            code: 400
            description: The request could not be understood by the server due to malformed syntax.
            name: Bad Request
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Hubble Network Packet Webhooks API

Operations 5

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification