GET
/v1/webhooksList webhook endpoints
The organisation's endpoints with their subscription, filters, state and failure streak.
Scope
webhooks.manageReturns
12 fields of the 200 answer
idstringrequiredurlstringrequireddescriptionstring or nullrequiredeventsarray of stringrequiredfiltersobjectrequired4 fields
postflowIdstringpostbatchIdstringisTestbooleanintegrationInstallationIdstringactivebooleanrequiredfailureStreakintegerrequireddisabledAtdate-time or nullrequiredlastDeliveryAtdate-time or nullrequiredlastStatusenum or nullrequiredSUCCEEDEDFAILEDEXHAUSTEDcreatedAtdate-timerequiredupdatedAtdate-timerequiredResponses
200Success
401Authentication required or API key invalid
403Permission or scope missing, organisation suspended
429Rate limited for this API key and class; wait Retry-After seconds
otherError (RFC 9457 problem details)