Catalogue / Messaging

Webhook endpoint

messagingwebhook-endpoint

HTTP endpoint that receives callbacks from a third party.

Category
Messaging
Properties
4
Components
4
Rules
1
Properties · 4 defined by this kind

A node of this kind resolves each property from its own props, then the component's defaults, then the default below.

propertytypevaluesrequireddefault
idempotentboolean—nofalse
managedboolean—nofalse
retriedByCallerboolean—notrue
signatureVerifiedboolean—nofalse
Rules for this kind · 1
webhook-without-signature-or-idempotency

A webhook is a public endpoint that its caller retries. Without signature verification anyone can post a fake event; without idempotency the provider's own retries apply the same event twice.

  • — any of these hold:
  • — the node's `signatureVerified` is false
  • — the node's `idempotent` is false
Components · 4
Source
# yaml-language-server: $schema=../schema/kind.schema.json
# Abstract kind: An HTTP endpoint you expose to receive callbacks from a third party (PSP, SaaS, provider).
schemaVersion: "1"
type: "kind"
id: "webhook-endpoint"
category: "messaging"
properties:
  signatureVerified:
    type: "boolean"
    default: false
  idempotent:
    type: "boolean"
    default: false
  retriedByCaller:
    type: "boolean"
    default: true
  managed:
    type: "boolean"
    default: false

The same page as markdown, for an agent: /catalogue/kinds/webhook-endpoint.md