/ 
Business-GoCardless-1.00
⭐ Starred 1 / Business::GoCardless::Webhook

NAME

Business::GoCardless::Webhook

DESCRIPTION

A class for gocardless webhooks, extends Business::GoCardless::Resource. For more details see the gocardless API documentation specific to webhooks: https://developer.gocardless.com/#webhook-overview

ATTRIBUTES

resource_type
action

Operations on a webhook

json

Allows you to set the json data sent to you in the webhook:

$Webhook->json( $json_data )

Will throw a Business::GoCardless::Exception exception if the json fails to parse or if the signature does not match the payload data.

resources

Returns an array of resource objects (Bill, Subscription, etc) that are present in webhook allowing you to do things with them or update your own data:

if ( $Webhook->is_bill ) {
	foreach my $Bill ( $Webhook->resources ) {
		...
	}
} elsif ( $Webhook->is_subscription ) {
	...

Shortcut methods to get the type of data in the webhook, and thus the type of objects that will be returned by the call to ->resources

is_bill

True if the webhook is for bills

is_pre_authorization

True if the webhook is for pre authorizations

is_subscription

True if the webhook is for subscriptions

is_legacy

See if the webhook is a legacy (Basic API) webhook

	if ( $Webhook->is_legacy ) {
        ...
    }

CONFIRMING WEBHOOKS

According to the gocardless API docs you should respond once the signature of the webhook has been checked. The response is a HTTP status 200 code:

HTTP/1.1 200 OK

You should handle this in your own code, the library will not do it for you. See https://developer.gocardless.com/#response for more information

AUTHOR

Lee Johnson - lee@payprop.com

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. If you would like to contribute documentation, features, bug fixes, or anything else then please raise an issue / pull request:

https://github.com/payprop/business-gocardless