How to create webhooks? I'm an API noob

VioletGarden · April 27, 2020, 10:36am

Hello! I’m brand new to the API and I have been reading through the documentation trying to figure out how to create a new webhook. I’m currently using Postman to help test and format my API calls for learning purposes, but would like to know how to programmatically create new webhooks. I tried using the example post payload given on the API Docs:

{
  "data": {
    "type": "webhook",
    "attributes": {
      "triggers": ["members:create"],
      "uri": "https://www.mywebsite.com/patreonWebhookTest",
    },
    "relationships": {
      "campaign": {
        "data": {"type": "campaign", "id": "mycampaignid"},
      },
    },
  },
}

But every time I try this, the API returns a 400 Bad Request error, saying “The browser (or proxy) sent a request that this server could not understand.”
The URL I am posting to is https://patreon.com/api/oauth2/v2/webhooks, and I have my access token saved as a bearer token.

What am I doing wrong here? Would anyone be willing to give me an example of what I should be doing?

codebard · April 27, 2020, 11:13am

Here is an example webhook from the PHP lib:

github.com

Patreon/patreon-php/blob/master/examples/create_webhook_to_notify_campaign_changes.php

<?php

require_once __DIR__.'/vendor/autoload.php';
 
use Patreon\API;
use Patreon\OAuth;

// This example shows you how to create a webhook at Patreon API to notify you when you have any member changes in your campaign

// Create a client first, using your creator's access token
$api_client = new API('YOURCREATORSACCESSTOKEN');

// If you dont know the campaign id you are targeting already, fetch your campaigns and get the id for the campaign you need. If you already know your campaign id, just skip this part

$campaigns_response = $api_client->fetch_campaigns();

// Get the campaign id
$campaign_id = $campaigns_response['data'][0]['id'];
// If you have more than one campaign in the return, you have to iterate to find the one you want. If return format is array (as is default), just iterate the array and get the id you want

This file has been truncated. show original

And below branch of WP plugin has the upcoming post sync webhooks.

The webhook related function creates a webhook:

github.com

Patreon/patreon-wordpress/blob/sync_posts/classes/patreon_api_v2.php

<?php


if( !defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly
}

// This file will include the v2 versin of Patreon_API class until v2 transition is complete

class Patreon_API {

	public $access_token;

	public function __construct( $access_token ) {
		$this->access_token = $access_token;
	}
	
	public function fetch_user() {

		// We construct the old return from the new returns by combining /me and pledge details

This file has been truncated. show original

Routing function has WP site’s endpoints to receive, verify and process incoming webhook posts:

github.com

Patreon/patreon-wordpress/blob/sync_posts/classes/patreon_routing.php

<?php

// If this file is called directly, abort.
if ( !defined( 'WPINC' ) ) {
	die;
}

class Patreon_Routing {

	function __construct() {
		
		add_action( 'generate_rewrite_rules', array( $this, 'add_rewrite_rules' ) );
		add_filter( 'query_vars', array( $this, 'query_vars' ) );
		add_action( 'parse_request', array( $this, 'parse_request' ) );
		add_action( 'init', array( $this, 'force_rewrite_rules' ) );
		
	}

	function force_rewrite_rules() {

This file has been truncated. show original

VioletGarden · April 27, 2020, 1:04pm

Thanks so much for the reply!
At first I was very confused as the data seemed to match up to mine, then I realized my problem was that I wasn’t escaping the slashes in the uri. When trying it with php, it automatically escaped them and worked.

As a seperate note, I want to create webhooks for the all new ‘posts:publish’ trigger. It’s working great so far! But, is there any way to get the required tiers for a post by it’s post ID?

codebard · April 27, 2020, 3:53pm

Unfortunately yet there isnt a way to get the tier of a post. Only that it is patron only. Tier info may be added to api in future.