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

Kiteworks webhook API

The webhook API from Kiteworks — 2 operation(s) for webhook.

Kiteworks webhook API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.2, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

6 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

Paths & Operations 6

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

webhook 6
GET
/webhooks
Get all webhooks
2 params → 200400500
POST
/webhooks
Create a new webhook
body → 201400500
GET
/webhooks/{id}
Get a specific webhook
1 param → 200400404500
PUT
/webhooks/{id}
Update a webhook
1 param body → 200400404409500
PATCH
/webhooks/{id}
Partially update a webhook
1 param body → 200400404409500
DELETE
/webhooks/{id}
Delete a webhook
1 param → 204400404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are WebhookResponse (7 properties), WebhookRequest (5 properties), WebhookPatchRequest (5 properties), Status (2 properties). Each schema is shown below with its type and property counts.

WebhookPatchRequest
object
Partial webhook payload — all fields are optional; only provided fields are updated
5 properties
Error
object
2 properties
WebhookResponse
object
7 properties 7 required
WebhookList
object
2 properties 2 required
WebhookRequest
object
5 properties 3 required
Status
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-webhook-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API