SWELLEnterprise Webhooks

How to use hooks with SWELLEnterprise RESTful API

Creating Subscriptions:

1- Create a subscription: sending a POST request to the https://app.swellsystem.com/api/subscribe after basic authentication with your username and password. 

Request body should have the endpoint and event this hook will subscribe to in the form of a JSON object // with appropriate headers

Authentication

==============

Basic Authentication with username and password

Subscriptions

===========

Subscription Endpoints

Get all subscriptions and events for user 

GET: https://app.swellsystem.com/api/subscribe

To create a subscription

POST: https://app.swellsystem.com/api/subscribe

Request body: should be of content type application/json, appropriate headers are needed

{

     "url" => endpoint,

     "event" => the trigger or event captured in swell,

}

To update a subscription

PATCH: https://app.swellsystem.com/api/subscribe/ + ID

Request body: should be of content type application/json, appropriate headers are needed

{

     "url" => new updated endpoint,

     "event" => new updated trigger or event captured in swell,

}

To delete a subscription/unsubscribe from an event

DELETE: https://app.swellsystem.com/api/subscribe/ + ID

Events

=======

Events for clients, leads, contacts, invoices are currently working and new events will be added and documented.

Example client event to subscribe to:

client.create

client.update

client.delete

Updated on: 10/30/2019