GoCardless webhooks will not deserialize into a bare event: wrap in a root object

TL;DR

Deserialize GoCardless webhooks into a root object that has an events list, not into a single event. The body shape is an object with an events array, each entry carrying id, resource_type, action, links, and details.

Steps

1. Deserialize GoCardless webhooks into a root object that has an events list, not into a single event. The body shape is an object with an events array, each entry carrying id, resource_type, action, links, and details. In .NET that means a Root class with a List of the SDK's event resource, then read each event's action to route it. If webhook parsing throws, check the wrapper shape first before suspecting the signature or the stream reading.

When to use

You are seeing this: Deserialize GoCardless webhooks into a root object that has an events list, not into a single event. Use this skill when you run into "GoCardless webhooks will not deserialize into a bare event: wrap in a root object".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

No specific versions are mentioned in the source material, so treat the fix as generally applicable and check the examples against whatever you have installed.

Why this happens

The original report does not dig into a root cause. It documents the symptom and the fix that resolved it.

Source: Stack Overflow #45413721 (top answer, 4 votes): A .NET developer read the GoCardless webhook request stream into a string and tried to deserialize it straight into an event object, which failed. The payload is not a bare event; it is a wrapper object holding an events array, so direct deserialization into the event type cannot work.

Verified resolution: Deserialize GoCardless webhooks into a root object that has an events list, not into a single event. The body shape is an object with an events array, each entry carrying id, resource_type, action, links, and details. In .NET that means a Root class with a List of the SDK's event resource, then read each event's action to route it. If webhook parsing throws, check the wrapper shape first before suspecting the signature or the stream reading.

Source URL: https://stackoverflow.com/questions/45413721