# Hookdeck Generator API

Copy as Markdown[View as Markdown](/docs/plugins/hookdeck/api.md)

***

## Overview[​](#overview "Direct link to 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[​](#required-fields "Direct link to Required fields")

### `hookdeckApiKey`[​](#hookdeckApiKey "Direct link to 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[​](#optional-fields "Direct link to Optional fields")

### `domain`[​](#domain "Direct link to 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`[​](#connectionSourcedMatch "Direct link to 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`[​](#processMaxEvents "Direct link to 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`[​](#logLevel "Direct link to 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",
  },
],
```