Webhook

This page is auto-generated from the formations OpenAPI spec. Do not edit manually — run pnpm generate-formations-resource-docs to regenerate.

Registers an HTTPS endpoint to receive SOAT platform event notifications.

Syntax

type: webhook
properties:
  name: String
  description: String
  url: String
  events: String[]

Output

The physical resource ID is the public ID of the created resource. Reference it from other resources with a ref expression:

      some_field:
        ref: MyWebhook

Properties

name

Webhook display name

Required: Yes Type: String

---

description

Optional description

Required: No Type: String Nullable: Yes

---

url

HTTPS endpoint that receives event payloads

Required: Yes Type: String

---

events

Event types to subscribe to (e.g. memory.updated)

Required: Yes Type: Array of String

---