Skip to main content

Hookdeck Generator API

Overview​

API for the EventCatalog Hookdeck generator.

Example eventcatalog.config.js file

eventcatalog.config.js
export default {
  title: 'OurLogix',
  tagline: 'A comprehensive logistics and shipping management company',
  organizationName: 'OurLogix',
  homepageLink: 'https://eventcatalog.dev/',
  landingPage: '',
  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
  trailingSlash: false,
  base: '/',
  logo: {
    alt: 'EventCatalog Logo',
    src: '/logo.png',
    text: 'OurLogix',
  },
  docs: {
    sidebar: {
      showPageHeadings: true,
    },
  },
  generators: [
    [
      "@hookdeck/eventcatalog-generator",
      {
        hookdeckApiKey: process.env.HOOKDECK_API_KEY,
        domain: "Payments",
        connectionSourcedMatch: "payments-.*",
        processMaxEvents: 200,
        logLevel: "debug",
      },
    ],
  ],
};

Required fields​

hookdeckApiKey​

  • Type: String

Hookdeck Project API Key to generate an EventCatalog visualization from.

eventcatalog.config.js
[
  '@hookdeck/eventcatalog-generator',
  {
    hookdeckApiKey: process.env.HOOKDECK_API_KEY,
  },
],

Optional fields​

domain​

The domain you want the services be associated with in your catalog.

  • Type: String
eventcatalog.config.js
[
  '@hookdeck/eventcatalog-generator',
  {
    hookdeckApiKey: process.env.HOOKDECK_API_KEY,
    domain: "Payments",
  },
],

connectionSourcedMatch​

Regular expression match for Source names on Connections.

  • Type: String
eventcatalog.config.js
[
  '@hookdeck/eventcatalog-generator',
  {
    hookdeckApiKey: process.env.HOOKDECK_API_KEY,
    connectionSourcedMatch: "payments-.*",
  },
],

processMaxEvents​

The maximum number of Requests/Events to process per Source/Destination

  • Type: Integer
eventcatalog.config.js
[
  '@hookdeck/eventcatalog-generator',
  {
    hookdeckApiKey: process.env.HOOKDECK_API_KEY,
    processMaxEvents: 200,
  },
],

logLevel​

The level to log at.

  • Type: fatal | error | warn | info | debug | trace
eventcatalog.config.js
[
  '@hookdeck/eventcatalog-generator',
  {
    hookdeckApiKey: process.env.HOOKDECK_API_KEY,
    logLevel: "debug",
  },
],