Partners
========

.. toctree::
    :maxdepth: 2
    :caption: Contents:

    gocardless
    mailchimp
    xero

Generic Partner Webhook
-----------------------

This is a general purpose end-point for capturing webhooks sent from partners. This end-point expects a JSON body to be sent for later processing. If signatures need checking, data re-formatting or more specialised treatment then contact the team for bespoke setup.

.. code-block:: http

	http POST /api/v1/$FLOCK/partner/{partner}/hook/
	HTTP/1.1 200 OK

	{
	    "message": "ok"
	}


GoCardless has a dedicated webhook endpoint which verifies the signatures of the webhooks.

``/api/v1/partner/gocardless/hook/``

.. todo

	Google
	----------

	|	``/api/v1/$FLOCK/partner/google/``
	|	``/api/v1/$FLOCK/partner/google/calendars/``
	|	``/api/v1/$FLOCK/partner/google/revoke/``
	|	``/api/v1/$FLOCK/partner/google/test/``



	Dropbox
	-------

	Connect SheepCRM to Dropbox
	^^^^^^^^^^^^^^^^^^^^^^^^^^^

	GET to the auth end point will begin the user OAuth2 flow ending with auth-finish.

	| ``/api/v1/$FLOCK/partner/dropbox/auth/``
	| ``/api/v1/$FLOCK/partner/dropbox/auth-finish/``

	Revoke Dropbox API Access
	^^^^^^^^^^^^^^^^^^^^^^^^^

	Clears acccess tokens thereby disconnecting SheepCRM from Dropbox

	.. code-block:: http

		http DELETE /api/v1/$FLOCK/partner/dropbox/revoke/
		HTTP/1.1 200 OK

		{}


	Other Partners
	--------------

	|``/api/v1/$FLOCK/partner/clearbit/{resource_type}/``
	|``/api/v1/$FLOCK/partner/crbonline/(?P<id>[\w\-]+)/``
	|``/api/v1/$FLOCK/partner/dial9/call/``
	|``/api/v1/$FLOCK/partner/discourse/sso``
	|``/api/v1/$FLOCK/partner/eventbrite/``
	|``/api/v1/$FLOCK/partner/vend/``
	|``/api/v1/$FLOCK/partner/woocommerce/hook/``
	|
	|``/api/v1/$FLOCK/partner/zapier/fields/{resource_type}/``
	|``/api/v1/$FLOCK/partner/{partner}/callback/``
	|
	|``/api/v1/partner/{partner}/callback/````