Packet Webhooks

Create a Webhook Endpoint

Register an endpoint that can receive webhook events for packet data.

Required Scope: write-webhooks

post/v1/org/{org_id}/webhooks

Request

  • Base URL: https://api.hubble.com
  • URL: https://api.hubble.com/v1/org/{org_id}/webhooks
  • Auth: HTTP bearer

Path parameters

org_idstring uuid required

The ID for an organization

Your organization ID

Request body

urlstring

A webhook url

max_batch_sizeinteger

The maximum number of packets that Hubble will batch into one webhook request

namestring

A name/description for a webhook

Response

A registered webhook endpoint

urlstring

A webhook url

max_batch_sizeinteger

The maximum number of packets that Hubble will batch into one webhook request

webhook_idstring

An identifier for a webhook

org_idstring uuid

The ID for an organization

namestring

A name/description for a webhook

secretstring

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.

Changes

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