Skip to content
Nodus

Read the status of a WebhookEndpoint

GET
/apis/nodus.dev/v1/webhookendpoints/{name}/status
 
curl --request GET \
  --url https://example.com/apis/nodus.dev/v1/webhookendpoints/example/status

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
name
required
string

The object’s name.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json

WebhookEndpoint is an HTTPS receiver for Events. Each delivery is signed with the Standard Webhooks scheme (webhook-id, webhook-timestamp and webhook-signature headers), sent to a public address without following redirects, and retried with exponential backoff for 3 days. A webhookendpoint.ping delivery is sent on create.

object
apiVersion
string
kind
string
metadata
object
annotations
object
key
additional properties
string
creationTimestamp
string
deletionGracePeriodSeconds
integer format: int64
deletionTimestamp
string
finalizers
Array<string>
nullable
generateName
string
generation
integer format: int64
labels
object
key
additional properties
string
managedFields
Array<object>
nullable
object
apiVersion
string
fieldsType
string
fieldsV1
object
key
additional properties
manager
string
operation
string
subresource
string
time
string
name
string
namespace
string
ownerReferences
Array<object>
nullable
object
apiVersion
required
string
blockOwnerDeletion
boolean
controller
boolean
kind
required
string
name
required
string
uid
required
string
resourceVersion
string
selfLink
string
uid
string
spec
required

WebhookEndpointSpec says where events go. Every field can change after create.

object
description

Description says what the endpoint is for.

string
enabled

Enabled pauses deliveries when false. Defaults to true.

boolean
eventTypes

EventTypes selects the events sent: exact types such as job.succeeded, prefixes such as job.* or billing.*, or *. Defaults to every event.

Array<string>
nullable
projects

Projects limits project events to these projects; empty means every project. Org-level events always match.

Array<string>
nullable
url
required

URL receives the deliveries. It must be https with a public address; redirects are not followed.

string
status

WebhookEndpointStatus is what Nodus observed.

object
conditions

Conditions are the latest observations: Healthy is False with reason DeliveriesFailing while the receiver fails.

Array<object>
nullable
object
lastTransitionTime
required
string
message
required
string
observedGeneration
integer format: int64
reason
required
string
status
required
string
type
required
string
deliveries24h

WebhookDeliveryCounts counts finished deliveries.

object
failed
required

Failed is the deliveries that exhausted their retries or were refused outright.

integer format: int32
succeeded
required

Succeeded is the deliveries the receiver accepted.

integer format: int32
failingSince

FailingSince is when the receiver started failing every delivery; unset while it works.

string
lastDelivery

WebhookLastDelivery is the latest delivery attempt of an endpoint.

object
attempt
required

Attempt counts the attempts of this delivery so far.

integer format: int32
eventType
required

EventType is the event’s type, such as job.succeeded.

string
statusCode
required

StatusCode is the receiver’s HTTP status; 0 when no response arrived.

integer format: int32
time
required

Time is when the attempt happened.

string
observedGeneration

ObservedGeneration is the spec generation the status reflects.

integer format: int64
secretRotation

WebhookSecretRotation describes a rotation in progress.

object
previousExpirationTime
required

PreviousExpirationTime is when the rotated-out secret stops signing.

string
signingSecret

SigningSecret is the whsec_ signing secret. It appears only in the create response and in a rotations response, never when the object is read again.

string
Example generated 
{
  "apiVersion": "example",
  "kind": "example",
  "metadata": {
    "annotations": {
      "additionalProperty": "example"
    },
    "creationTimestamp": "example",
    "deletionGracePeriodSeconds": 1,
    "deletionTimestamp": "example",
    "finalizers": [
      "example"
    ],
    "generateName": "example",
    "generation": 1,
    "labels": {
      "additionalProperty": "example"
    },
    "managedFields": [
      {
        "apiVersion": "example",
        "fieldsType": "example",
        "fieldsV1": {
          "additionalProperty": "example"
        },
        "manager": "example",
        "operation": "example",
        "subresource": "example",
        "time": "example"
      }
    ],
    "name": "example",
    "namespace": "example",
    "ownerReferences": [
      {
        "apiVersion": "example",
        "blockOwnerDeletion": true,
        "controller": true,
        "kind": "example",
        "name": "example",
        "uid": "example"
      }
    ],
    "resourceVersion": "example",
    "selfLink": "example",
    "uid": "example"
  },
  "spec": {
    "description": "example",
    "enabled": true,
    "eventTypes": [
      "example"
    ],
    "projects": [
      "example"
    ],
    "url": "example"
  },
  "status": {
    "conditions": [
      {
        "lastTransitionTime": "example",
        "message": "example",
        "observedGeneration": 1,
        "reason": "example",
        "status": "example",
        "type": "example"
      }
    ],
    "deliveries24h": {
      "failed": 1,
      "succeeded": 1
    },
    "failingSince": "example",
    "lastDelivery": {
      "attempt": 1,
      "eventType": "example",
      "statusCode": 1,
      "time": "example"
    },
    "observedGeneration": 1,
    "secretRotation": {
      "previousExpirationTime": "example"
    },
    "signingSecret": "example"
  }
}

default

Section titled “ default ”

An error: a metav1.Status whose reason is a registered code.

Media type application/json

Status is the error body of every API response: a Kubernetes metav1.Status (so kubectl and client-go understand it) plus three top-level extensions that those clients ignore (ADR-028).

object
apiVersion
string
code
integer format: int32
details
object
causes
Array<object>
nullable
object
field
string
message
string
reason
string
group
string
kind
string
name
string
retryAfterSeconds
integer format: int32
uid
string
docs

Docs is the URL of the code’s docs page.

string
fix

Fix says what to do next, for example a CLI command or the field to change.

string
kind
string
message
string
metadata
object
continue
string
remainingItemCount
integer format: int64
resourceVersion
string
selfLink
string
shardInfo
object
selector
required
string
reason
string
requestId

RequestID identifies the request in logs and support tickets.

string
status
string
Example generated 
{
  "apiVersion": "example",
  "code": 1,
  "details": {
    "causes": [
      {
        "field": "example",
        "message": "example",
        "reason": "example"
      }
    ],
    "group": "example",
    "kind": "example",
    "name": "example",
    "retryAfterSeconds": 1,
    "uid": "example"
  },
  "docs": "example",
  "fix": "example",
  "kind": "example",
  "message": "example",
  "metadata": {
    "continue": "example",
    "remainingItemCount": 1,
    "resourceVersion": "example",
    "selfLink": "example",
    "shardInfo": {
      "selector": "example"
    }
  },
  "reason": "example",
  "requestId": "example",
  "status": "example"
}