Webhook receiver

Generic HTTP endpoint exposed to receive callbacks from third parties.

Provider: default
Kind: Webhook endpoint
Category: Messaging
Official docs: https://www.rfc-editor.org/rfc/rfc9421.html

Properties · 3 set by this component

property	type	values	required	kind default	this component
idempotent	boolean	—	no	false	▸ false
managed	boolean	—	no	false	inherited
persistBeforeAck · component property	boolean	—	no	false	inherited
retriedByCaller	boolean	—	no	true	▸ true
signatureVerified	boolean	—	no	false	▸ false

Rules that apply · 1

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Webhook without signature verification or idempotencyerror

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

Use it in a design

nodes:
  - { id: "webhook-receiver", component: "webhook-receiver" }

Other Webhook endpoint products · 3

Hookdeckhookdeckwebhook-endpoint Svixsvixwebhook-endpoint Generic webhook endpointwebhook-endpointwebhook-endpoint

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Generic HTTP endpoint you expose for third-party callbacks (payment provider, SaaS events).
3# Nothing is verified, deduplicated or persisted unless the design says so.
4schemaVersion: "1"
5type: "component"
6id: "webhook-receiver"
7kind: "webhook-endpoint"
8provider: "default"
9docs: "https://www.rfc-editor.org/rfc/rfc9421.html"
10defaults:
11  signatureVerified: false
12  idempotent: false
13  retriedByCaller: true
14properties:
15  persistBeforeAck:
16    type: "boolean"
17    default: false

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