Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Helicone Webhooks API

The Webhooks API from Helicone — 3 operation(s) for webhooks.

Helicone Webhooks API is one of 33 APIs that Helicone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an API reference, and an engineering blog.

This API exposes 4 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.helicone.ai/, http://localhost:8585/.

4 operations 3 paths 11 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://ai-gateway.helicone.ai
Authentication
API Key
License
MIT
Resource Areas
1

Authentication & Security 1

Helicone Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

  • api_key — Bearer token authentication. Format: 'Bearer YOURAPIKEY'

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 4
POST
/v1/webhooks
NewWebhook body → 200
GET
/v1/webhooks
GetWebhooks → 200
DELETE
/v1/webhooks/{webhookId}
DeleteWebhook 1 param → 200
POST
/v1/webhooks/{webhookId}/test
TestWebhook 1 param → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are WebhookData (3 properties), ResultError_unknown_ (2 properties), ResultSuccess_unknown_ (2 properties), ResultSuccess__id-string--created_at-string--destination-string--version-string--config-string--hmac_key-string_-Array_ (2 properties). Each schema is shown below with its type and property counts.

Result__id-string--created_at-string--destination-string--version-string--config-string--hmac_key-string_-Array.string_
ResultSuccess__id-string--created_at-string--destination-string--version-string--config-string--hmac_key-string_-Array_
object
2 properties 2 required
ResultSuccess_unknown_
object
2 properties 2 required
ResultError_unknown_
object
2 properties 2 required
WebhookData
object
3 properties 2 required
Record_string.any_
object
Construct a type with a set of properties K of type T
Result__success-boolean--message-string_.string_
ResultSuccess_null_
object
2 properties 2 required
ResultSuccess__success-boolean--message-string__
object
2 properties 2 required
Result_null.string_
ResultError_string_
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

helicone-webhooks-api-openapi.yml Raw ↑

Other APIs Helicone publishes across the network.

Helicone Agent API
Helicone API Key API
Helicone Comparison API
Helicone Credits API
Helicone Customer API
Helicone Dashboard API
Helicone Dataset API
Helicone Evals API
Helicone Evaluator API
Helicone Experiment API
Helicone HeliconeSql API
Helicone Integration API