docs: Add Hookdeck example

[isshaddad]

Add documentation for integrating Hookdeck with Trigger.dev to receive webhooks and forward them to Trigger.dev tasks.

---

[changeset-bot]

⚠️ No Changeset found

Latest commit: d6a2f38

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This pull request adds documentation for integrating Hookdeck webhook services with Trigger.dev. A new guide page is created at docs/guides/examples/hookdeck-webhook.mdx containing setup instructions, configuration steps (destination, transformation, connection), a TypeScript code example demonstrating webhook payload access, and testing procedures. The new guide is registered in the documentation index and linked from the webhook guides overview and main guides introduction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description provides a brief explanation of the changes but lacks required template sections like Testing, Changelog, and the contribution checklist.	Add the missing sections from the template: Testing steps, detailed Changelog entry, and complete the contribution checklist to fully document the changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: Add Hookdeck example' clearly and concisely summarizes the main change, which is adding documentation for a Hookdeck integration example.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/hookdeck-example

---

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c059570 and d6a2f38.

📒 Files selected for processing (4)

• docs/docs.json
• docs/guides/examples/hookdeck-webhook.mdx
• docs/guides/frameworks/webhooks-guides-overview.mdx
• docs/guides/introduction.mdx

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{js,ts,jsx,tsx,json,md,yaml,yml}

📄 CodeRabbit inference engine (AGENTS.md)

Format code using Prettier before committing

Files:

• docs/docs.json

🧠 Learnings (7)

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use the `task()` function from `trigger.dev/sdk/v3` to define tasks with id and run properties

Applied to files:

• docs/guides/introduction.mdx
• docs/guides/examples/hookdeck-webhook.mdx

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Generate example payloads for tasks when possible

Applied to files:

• docs/guides/introduction.mdx
• docs/guides/examples/hookdeck-webhook.mdx

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `trigger.dev/sdk/v3` for all imports in Trigger.dev tasks

Applied to files:

• docs/guides/introduction.mdx
• docs/guides/examples/hookdeck-webhook.mdx

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `yourTask.trigger()` to trigger a task from inside another task with specified payload

Applied to files:

• docs/guides/introduction.mdx
• docs/guides/examples/hookdeck-webhook.mdx

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `tasks.trigger()` with type-only imports to trigger tasks from backend code without importing the task implementation

Applied to files:

• docs/guides/introduction.mdx
• docs/guides/examples/hookdeck-webhook.mdx

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `schemaTask()` from `trigger.dev/sdk/v3` with Zod schema for payload validation

Applied to files:

• docs/guides/examples/hookdeck-webhook.mdx

📚 Learning: 2025-11-27T16:27:35.304Z

Learnt from: CR
Repo: triggerdotdev/trigger.dev PR: 0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-11-27T16:27:35.304Z
Learning: Applies to **/trigger/**/*.{ts,tsx,js,jsx} : Use `tasks.batchTrigger()` to trigger multiple runs of a single task with different payloads

Applied to files:

• docs/guides/examples/hookdeck-webhook.mdx

🔇 Additional comments (4)

docs/guides/examples/hookdeck-webhook.mdx (1)

1-71: Documentation structure looks good.

The guide provides a clear, logical flow: overview → key features → setup steps (destination, transformation, connection) → task code → testing. The Hookdeck-specific configuration steps are well-documented with appropriate external links.

docs/guides/frameworks/webhooks-guides-overview.mdx (1)

34-37: LGTM!

The new Hookdeck card entry is well-placed, uses a consistent icon, and the link path matches the new documentation file location.

docs/guides/introduction.mdx (1)

40-40: LGTM!

The new table entry is appropriately placed among webhook-related guides and uses a consistent description format.

docs/docs.json (1)

355-356: LGTM!

The new page entry is correctly placed within the Webhooks navigation group and the path matches the documentation file location.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional flags.