fix: Support custom repository_dispatch actions

[martincostello]

Resolves #711

---

Before the change?

• Custom repository_dispatch events cannot be deserialized.

After the change?

• Custom repository_dispatch payloads can be deserialized

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

• Yes
• No

---

[github-actions]

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

[Copilot]

Pull Request Overview

This PR adds support for user-defined repository_dispatch actions by introducing a custom event type and updating the converter to fall back to it when an action isn’t recognized.

• Added a new RepositoryDispatchCustomEvent record inheriting from RepositoryDispatchEvent
• Updated WebhookConverter to detect unregistered actions and route them to the custom event
• Provided a sample JSON payload for testing custom repository_dispatch events

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
test/Octokit.Webhooks.Test/Resources/repository_dispatch/custom.payload.json	New sample payload illustrating a custom action
src/Octokit.Webhooks/Events/RepositoryDispatch/RepositoryDispatchCustomEvent.cs	New empty record type for custom repository_dispatch events
src/Octokit.Webhooks/Converter/WebhookConverter.cs	Logic updated to map unknown actions to the custom event type

Comments suppressed due to low confidence (3)

src/Octokit.Webhooks/Converter/WebhookConverter.cs:36

• [nitpick] Using a local variable named type shadows the System.Type class and can cause confusion. Consider renaming this variable to eventType or targetType for clarity.

        Type? type = null;

test/Octokit.Webhooks.Test/Resources/repository_dispatch/custom.payload.json:1

• A JSON sample for a custom repository_dispatch event has been added, but there isn’t a corresponding unit test to deserialize it into RepositoryDispatchCustomEvent. Please add a test in WebhookConverterTests to verify this mapping.

{

src/Octokit.Webhooks/Converter/WebhookConverter.cs:46

• The fallback condition for custom repository_dispatch events checks if typeToConvert == typeof(RepositoryDispatchEvent), but the converter is registered for WebhookEvent so this never matches. You may need to detect repository_dispatch by inspecting the JSON or adjust the type check to ensure custom events are correctly routed.

        if (type == null && typeToConvert == typeof(Events.RepositoryDispatchEvent))

[JamieMagee]

Thanks for this! But since I merged #708, this is going to come in a major release.

[martincostello]

this is going to come in a major release.

Do you have a rough ETA on v3? Would prefer to not have to consume the NuGet packages from CI directly (I don't like the need to use a GitHub PAT to get packages from the repo's NuGet artifacts feed).

[JamieMagee]

@martincostello I need to get #716 in, and I am also considering #710. I was wondering if I could get your opinion on it please?

[JamieMagee]

@martincostello did v3.0.0 work for you?

[martincostello]

Yes, great thanks!