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

ChargeDesk Webhooks API

Manage webhook configurations

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

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.chargedesk.com/v1.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.chargedesk.com/v1
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

ChargeDesk Webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use your ChargeDesk secret key as the username with an empty password. Format: Authorization: YOURSECRETKEY:

Paths & Operations 3

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

Webhooks 3

Manage webhook configurations

GET
/webhooks
List all webhooks
listWebhooks → 200401
POST
/webhooks
Create a webhook
createWebhook body → 200400401
DELETE
/webhooks/{webhook_id}
Delete a webhook
deleteWebhook 1 param → 200401404

Schemas 3

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

Webhook
object
6 properties
WebhookInput
object
2 properties 1 required
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chargedesk-webhooks-api-openapi.yml Raw ↑

Other APIs ChargeDesk publishes across the network.

ChargeDesk REST API
ChargeDesk Charges API
ChargeDesk Customers API
ChargeDesk Gateway API
ChargeDesk Products API
ChargeDesk Subscriptions API