Webhook protocols

The following webhook protocols are currently supported by the Ketch Platform

Metadata

namerequired?description
uidyesWill be a unique UUIDv4, and uniquely identifies the request
tenantyesWill be the Ketch tenant code where the request originated

Error

An Error MUST be returned with the appropriate HTTP status code with an Error JSON object. The Content-Type must
be application/json.

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 238

{
  "apiVersion": "v1",
  "kind": "Error",
  "metadata": {
    "uid": "22880925-aac5-42f9-a653-cb6921d361ff",
    "tenant": "axonic"
  },
  "error": {
    "code": 404,
    "status": "not_found",
    "message": "Not found"
  }
}

Fields

namerequired?description
apiVersionyesAPI version. Must be dsr/v1
kindyesMessage kind. Must be Error
metadatayesMetadata object
error.codeyesThe HTTP status code
error.statusyesA string [code](#Error status code) representing the error
error.messageyesA user-friendly error message (e.g., "Not found")

Error status code

statusdescription
conflictaction cannot be performed
internalinternal error
unavailableservice is unavailable
invalidvalidation failed
not_foundentity does not exist
timeoutoperation timed out
canceledoperation canceled
forbiddenoperation is not authorized
configurationconfiguration error
unimplementedunimplemented error