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

Channex Webhooks API

Manage event notification callbacks.

Channex Webhooks API is one of 7 APIs that Channex 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 and API documentation.

This API exposes 6 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://secure.channex.io/api/v1, https://staging.channex.io/api/v1.

6 operations 3 paths 5 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://secure.channex.io/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Channex Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as user-api-key (userApiKey). By default, every request must be authenticated.

  • userApiKey — Channex API key passed in the user-api-key request header. Generate a key in the Channex application under your account settings.

Paths & Operations 6

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

Webhooks 6

Manage event notification callbacks.

GET
/webhooks
List webhooks
listWebhooks → 200
POST
/webhooks
Create a webhook
createWebhook body → 201
GET
/webhooks/{id}
Get a webhook
getWebhook 1 param → 200
PUT
/webhooks/{id}
Update a webhook
updateWebhook 1 param body → 200
DELETE
/webhooks/{id}
Delete a webhook
deleteWebhook 1 param → 200
POST
/webhooks/test
Test a webhook
testWebhook body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are WebhookAttributes (8 properties), Webhook (3 properties), WebhookList (2 properties), WebhookResponse (1 property). Each schema is shown below with its type and property counts.

WebhookAttributes
object
8 properties 2 required
Webhook
object
3 properties
WebhookWriteRequest
object
1 property 1 required
WebhookList
object
2 properties
WebhookResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

channex-webhooks-api-openapi.yml Raw ↑

Other APIs Channex publishes across the network.

Channex ARI API
Channex Bookings API
Channex Channels API
Channex Properties API
Channex Rate Plans API
Channex Room Types API