---
id: "webhook-receiver"
type: "component"
kind: "webhook-endpoint"
provider: "default"
category: "messaging"
docs: "https://www.rfc-editor.org/rfc/rfc9421.html"
url: "https://localhost:3000/catalogue/components/webhook-receiver"
---

# Webhook receiver

Generic HTTP endpoint exposed to receive callbacks from third parties.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Webhook endpoint](https://localhost:3000/catalogue/kinds/webhook-endpoint) |
| Category | Messaging |
| Official docs | [https://www.rfc-editor.org/rfc/rfc9421.html](https://www.rfc-editor.org/rfc/rfc9421.html) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `idempotent` | boolean | — | no | false | **false** |
| `managed` | boolean | — | no | false | inherited |
| `persistBeforeAck` | boolean | — | no | false | inherited |
| `retriedByCaller` | boolean | — | no | true | **true** |
| `signatureVerified` | boolean | — | no | false | **false** |

Bold values are the ones this component pins.

## Rules that apply · 1

### Webhook without signature verification or idempotency `webhook-without-signature-or-idempotency` (error)

- Page: https://localhost:3000/catalogue/rules/webhook-without-signature-or-idempotency.md
- Why: 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.
- Applies to: every node of kind webhook-endpoint
- Message: Webhook '{{node.id}}' does not verify signatures or is not idempotent. Verify the caller's signature and deduplicate by event id.

It fires when:

- any of these hold:
  - the node's `signatureVerified` is false
  - the node's `idempotent` is false

## Other products of the same kind · 3

- [Hookdeck](https://localhost:3000/catalogue/components/hookdeck.md) `hookdeck` — default
- [Svix](https://localhost:3000/catalogue/components/svix.md) `svix` — default
- [Generic webhook endpoint](https://localhost:3000/catalogue/components/webhook-endpoint.md) `webhook-endpoint` — default

## Use it in a design

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

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Generic HTTP endpoint you expose for third-party callbacks (payment provider, SaaS events).
# Nothing is verified, deduplicated or persisted unless the design says so.
schemaVersion: "1"
type: "component"
id: "webhook-receiver"
kind: "webhook-endpoint"
provider: "default"
docs: "https://www.rfc-editor.org/rfc/rfc9421.html"
defaults:
  signatureVerified: false
  idempotent: false
  retriedByCaller: true
properties:
  persistBeforeAck:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/components/webhook-receiver
