skills.rest
webiny
webinyOFFICIAL
Explore all skills by this author →
Website𝕏@WebinyCMSGitHub

webiny-api-webhooks-catalog

Catalogs Webiny webhook abstractions with import paths and source file references.

8.0k|673|Updated Jan 9, 2018
Search Tags:#api#Webhooks#typeScript#webiny#payload signing#event dispatch#import catalog
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-webhooks-catalog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webiny-api-webhooks-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/webhooks
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-webhooks-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with Webiny's webhook system often struggle to locate the correct abstraction, its exact import path, and its source file among the many types and classes spread across the codebase.

Core Features & Use Cases

  • Abstraction Catalog: Lists 15 webhook-related abstractions including WebhookDispatcher, WebhookFactory, WebhookSignPayload, and WebhookVerifyPayload with exact import statements.
  • Type Reference: Documents domain types such as Webhook, WebhookDelivery, WebhookCmsEntry, and IListMeta with their source file locations.
  • Use Case: When implementing a webhook integration in a Webiny project, look up WebhookSignPayload to sign outgoing payloads following the Standard Webhooks spec, then read the referenced source file for exact interfaces.

Quick Start

Ask the AI to show the import path and source file for WebhookDispatcher from the webiny api webhooks catalog.

Frequently Asked Questions about webiny-api-webhooks-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I import webhook abstractions in Webiny?▼

Import webhook abstractions using the path webiny/api/webhooks, for example import { WebhookDispatcher } from "webiny/api/webhooks". Always read the referenced source file first to confirm the exact interface and types.

What webhook types are available in the Webiny API?▼

The catalog includes Webhook, WebhookCmsEntry, WebhookDelivery, WebhookDeliveryStatus, IListMeta, and IWebhookPayload types. It also lists classes like WebhookDispatcher, WebhookFactory, WebhookProvider, WebhookSignPayload, and WebhookVerifyPayload.

Does Webiny support signing webhook payloads?▼

Yes, WebhookSignPayload signs outgoing webhook payloads and WebhookVerifyPayload verifies incoming ones. Both follow the Standard Webhooks specification documented at standardwebhooks.com.

How does Webiny route events to webhooks?▼

WebhookDispatcher routes a domain event to all matching enabled webhooks via background tasks. The actual delivery is handled through the SendWebhookTask feature, which produces IWebhookPayload data.

Where do I find the exact interface for a Webiny webhook type?▼

Each catalog entry lists a source file such as @webiny/webhooks/api/domain/Webhook.ts. You must read that source file to get the exact interface and type definitions before using the abstraction.

Related Skills

Explore More Software Engineering Skills→
webinywebiny
8.0k

backend-developer

Implement backend API features using Webiny architecture and GraphQL schemas.

Official
Advanced
abzhawabzhaw

webhook-design

Verify HMAC signatures and route webhook events to Julia handlers.

Community
Intermediate
EvolutionAPIEvolutionAPI
520

trigger-registry

Create, manage, and test event-driven triggers for webhook workflows.

Official
Intermediate
paulundpaulund

webhook-developer

Design outgoing webhooks with HMAC signing, HTTPS, and retry logic.

Community
Advanced