This is an old revision of the document!
Lime CRM Webhook Add-on
Gives Webhook functionality to Lime CRM. Webhooks makes it possible to create an subscription from an external system to events in Lime CRM. You can subscribe to new, update, delete and restore for all available LimeTypes.
You set up an subscription by posting a subscription request
{
"events" : ["company.new", "helpdesk.update"],
"target_url" : "https://example.org/hook/123"
}
Install
$ limeplug install lime-plug-webhooks
or add it to your solutions dependencies.txt
Endpoints
The endpoints are available under
Base url is https://{your_lime_app_url}/{your_lime_app}/api/v1/subscription/
List available subscriptions
GET: /subscription/available/
List current subscriptions
GET: /subscription/
Create a subscription
POST: /subscription/
request body:
{
"events" : ["company.new"],
"target_url" : "https://example.org/hook/123"
}
Updates a subscription
PUT: /subscription/:id
request body:
{
"events" : ["company.new"],
"target_url" : "https://example.org/hook/123"
}
Shows a subscription
GET: /subscription/:id
response body:
{
"id" : 1,
"events" : ["company.new"],
"target_url" : "https://example.org/hook/123",
"enabled": true
}
Deletes a subscription
DELETE: /subscription/:id