ziflow / chargify-webhook-java

Java library to parse the request body of a Chargify Webhook.

chargify-webhook-java

Java library to parse the request body of a Chargify Webhook.

Quick Start

To use this chargify-webhook-java project. Clone and build this repository, or use Maven.

Releases

Stable releases will be published to the central maven repository.

<dependency>
	<groupId>io.prowave</groupId>
	<artifactId>chargify-webhook-java</artifactId>
	<version>1.1.6</version>
</dependency>

Snapshots

Snapshots are not automatically published.

Usage

Spring-MVC

The easiest way to parse the webhook request body is my allowing SpringMVC to convert the parameters to a Map<String, String> for you, and then pass that Map to the ChargifyWebhookParser.

@Controller
@RequestMapping("/chargify")
public class ChargifyController {

	@RequestMapping(value = "/receiver", method = RequestMethod.POST)
	@ResponseBody
	public void receiver(@RequestParam Map<String, String> requestBody) throws IOException {

		ChargifyWebhook chargifyWebhook = ChargifyWebhookParser.parse(requestBody);

		if ("signup_success".equals(chargifyWebhook.getEvent())) {

			SignupSuccess ss = ChargifyMessageFactory.createChargifyMessage(chargifyWebhook.getPayload(),
					SignupSuccess.class);

		}

		if ("test".equals(chargifyWebhook.getEvent())) {

			Test test = ChargifyMessageFactory.createChargifyMessage(chargifyWebhook.getPayload(), Test.class);

		}

	}
}

Once you have the ChargifyWebhook from the ChargifyWebhookParser.parse() method, you have 3 options to access the parsed data.

1. You can access the Map<String, Object> directly from the ChargifyWebhook.getPayload() method. This is a bit cumbersome as you need to cast you Objects to String or Map<> depending on what node you are on, and this requires knowledge of the message you received.

2. You can convert the Map to JSON using Jackson2 (which is a required dependency of this project.

This is as simple as:

String jsonMessage = mapper.writeValueAsString(chargifyWebhook);

or you can just convert the payload

String jsonMessage = mapper.writeValueAsString(chargifyWebhook.getPayload());

3. There is a ChargifyMessageFactory that will convert the ChargifyWebhook to POJOs. This is the preferred method as it strongly types the attributes of the message, and provides convenient getters and setters for all known and published attributes that come in from the Chargify webhook.

Raw Request Body

Same as above, but you can pass the raw RequestBody as a String to the ChargifyWebhookParser.parse() method.

Whats included

Message Parser

• The requestBody parser
• The ability to create JSON for any webhook message type

POJO Support

Ignored Attributes

Since we had trouble getting a comprehensive list of all the payload attributes, we have added support for the ones we know about and ignored any others. If there are any attributes that need to be added to the POJOs, please add them and create a PR, or open an Issue.

Provided

• Test
• SignupSuccess
• CustomerUpdate
• PaymentSuccess
• PaymentFailure
• SubscriptionStateChange
• SignupFailure
• RenewalSuccess
• RenewalFailure
• BillingDateChange
• SubscriptionProductChange
• ExpiringCard
• ComponentAllocationChange
• UpcomingRenewalNotice
• EndOfTrialNotice - possible duplicate, or superceded by TrialEndNotice
• TrialEndNotice
• UpgradeDowngradeSuccess
• UpgradeDowngradeFailure
• ExpirationDateChange

Backlog

• SubscriptionCardUpdate
• MeteredUsage
• StatementClosed
• StatementSettled
• RefundSuccess
• RefundFailure

Other Considerations

NOTE
The current implementation only supports a subset of the total webhook message types. The ChargifyMessageFactory can and should be built out by other contributors as needed, and then issue a PR to merge back into this repo. Eventually, all message types will be supported and the Java community can easily consume Chargify Webhooks.