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

HeyMilo Webhooks API

Register, list, and manage webhook endpoints that receive real-time event notifications.

HeyMilo Webhooks API is one of 18 APIs that HeyMilo 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, an API reference, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.heymilo.ai.

4 operations 2 paths 10 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.heymilo.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

HeyMilo Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication. Pass your key in the X-API-KEY header.

Paths & Operations 4

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

Webhooks 4

Register, list, and manage webhook endpoints that receive real-time event notifications.

POST
/api/v2/webhooks
Register a webhook
createWebhook 3 params body → 201401404429422
GET
/api/v2/webhooks
List webhooks
listWebhooks 5 params → 200401404429422
GET
/api/v2/webhooks/{webhook_id}
Get webhook details
getWebhook 4 params → 200401404429422
DELETE
/api/v2/webhooks/{webhook_id}
Deactivate a webhook
deleteWebhook 4 params → 200401404429422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are WebhookResponse (8 properties), APIError (6 properties), APIErrorDetail (3 properties), CreateWebhookRequest (3 properties). Each schema is shown below with its type and property counts.

APIErrorDetail
object
3 properties 2 required
APIError
object
6 properties 3 required
ValidationError
object
3 properties 3 required
ListResponse_WebhookResponse_
object
2 properties 2 required
WebhookResponse
object
A webhook configuration.
8 properties 7 required
HTTPValidationError
object
1 property
SingleResponse_WebhookResponse_
object
2 properties 1 required
CreateWebhookRequest
object
Request body for creating a webhook.
3 properties 3 required
APIErrorResponse
object
1 property 1 required
PaginationMeta
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heymilo-webhooks-api-openapi.yml Raw ↑

Other APIs HeyMilo publishes across the network.

HeyMilo ATS API
HeyMilo Candidates API
HeyMilo Design Template Groups API
HeyMilo Design Templates API
HeyMilo Domains API
HeyMilo Email Template Groups API
HeyMilo Email Templates API
HeyMilo Health API
HeyMilo Interview Templates API
HeyMilo Interviewers API
HeyMilo Interviews API
HeyMilo Phone Numbers API