Skip to main content

Webhook

🟢 Supported

Collection Method

Buz is capable of collecting and routing webhooks from pretty much anywhere.

Namespace Method

Buz supports two ways of namespacing webhooks: arbitrary and named.

Arbitrary webhooks

All requests sent to the configured root webhook path are considered arbitrary and are assigned a single namespace of buz.hook.arbitrary.

For Example

If Buz is configured with a webhook path of /hook (the default), all requests to /hook will not be validated and will be namespaced according to buz.hook.arbitrary.

Yo

Since this method is basically a webhook catchall it should be used sparingly.

Named webhooks

Any webhooks sent to a schema-specific webhook path are namespaced according to the associated schema.

For Example

If Buz is configured with a webhook path of /hook (the default), all requests to /hook/com.iterable/payload/v1.0.json will be validated and namespaced according to the contents of the com.iterable/payload/v1.0.json schema.

Pro tip

This is the way.

Validation Method

Arbitrary webhooks: Not validated.

Named webhooks: Validated according to the associated schema.

Sample Webhook Configuration

webhook:
enabled: true # Whether or not to enable webhooks
path: /hook # Root path for incoming webhooks