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" 
}
$ limeplug install lime-plug-webhooks

or add it to your solutions dependencies.txt

The endpoints are available under

Base url is https://{your_lime_app_url}/{your_lime_app}/api/v1/subscription/

GET: /subscription/available/

GET: /subscription/

POST: /subscription/

request body:

{
    "events" : ["company.new"],
    "target_url" : "https://example.org/hook/123" 
}

PUT: /subscription/:id

request body:

{
    "events" : ["company.new"],
    "target_url" : "https://example.org/hook/123" 
}

GET: /subscription/:id

response body:

{
    "id" : 1,
    "events" : ["company.new"],
    "target_url" : "https://example.org/hook/123",
    "enabled": true
}

DELETE: /subscription/:id

  • Last modified: 6 years ago
  • by Filip Arenbo