Hookdeck Terraform Provider

The Hookdeck Event Gateway enables engineering teams to build, deploy, observe, and scale event-driven applications. For more information, see the Hookdeck documentation.

The Hookdeck Terraform provider enables you to manage your Hookdeck workspaces using IaC (Infrastructure-as-Code), including managing your sources, destinations, connections, transformations, and more. It also supports webhook registration workflow that allows you to configure webhooks as part of your CI/CD processes.

Installation

To install Hookdeck Terraform provider:

1. Obtain your Hookdeck API key from the dashboard
2. Add the following to your Terraform configuration file:

terraform {
  required_providers {
    hookdeck = {
      source  = "hookdeck/hookdeck"
    }
  }
}

provider "hookdeck" {
  # set HOOKDECK_API_KEY env var or optionally specify the key in the provider configuration
  api_key = var.hookdeck_api_key
}

Using the provider

This README gives a basic example; for more examples, see the examples/ folder, the rendered documentation on the Terraform Registry, or docs folder in this repository.

# Configure a source
resource "hookdeck_source" "my_source" {
  name = "my_source"
}

# Configure a destination
resource "hookdeck_destination" "my_destination" {
  name = "my_destination"
  type = "HTTP"
  config = jsonencode({
    url  = "https://myapp.example.com/api"
  })
}

# Configure a connection
resource "hookdeck_connection" "my_connection" {
  source_id      = hookdeck_source.my_source.id
  destination_id = hookdeck_destination.my_destination.id
}

For Source config and Destination config you must provide a JSON object. This means you do not get validation on the config property within your IDE or when running terraform plan. However, when running terraform apply the Hookdeck API will provide error responses if invalid configuration is received.

Dependencies

This provider is built on top of the Hookdeck API.

Contributing

Contributions are welcome. See CONTRIBUTING.md for development setup, running acceptance tests, documentation generation, and the release process. If you are working on this repository with an AI coding agent, see AGENTS.md.