astro-webhooks

🚀 Astro Webhooks (WIP)

Astro Webhooks helps you receive webhooks calls in your Astro apps.

Note:

This integration is still a work in progress! As we iron out the kinks, We'll let you know when it's ready for prime time.

📦 Installation

Quick Install

the astro add command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren’t sure which package manager you’re using, run the first command.) Then, follow the prompts, and type “y” in the terminal (meaning “yes”) for each one.

# Using PNPM
pnpm astro add astro-webhooks
# Using NPM
npx astro add astro-webhooks
# Using Yarn
yarn astro add astro-webhooks

Manual Install

First, install the astro-webhooks package using your package manager. (If you aren’t sure which package manager you’re using, run the first command.)

Using PNPM

pnpm install astro-webhooks

Using NPM

npm install astro-webhooks

Using Yarn

yarn add astro-webhooks

Then, apply this integration to your astro.config.mjs file using the integrations property:

import webhooks from 'astro-webhooks';

export default {
  // ...
  integrations: [webhooks()]
};

🥑 Usage

When you install this integration, things will be auto-wired for you.

📖 Configuration

This Astro integration allow you to pass those options easily in your astro.config.mjs file:

export default defineConfig({
  integrations: [
    webhooks({
      endpoints: []
    })
  ]
});

Available Options

Here is a list of options, that are allowed to be passed in the config:

export type WebhookOptions = {};

Changelog

Please see the Changelog for more information on what has changed recently.