Endpoints

The endpoints are available under the base url: 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" 
}

Optionally a secret can be added. The secret is used to sign the payload of a webhook.

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

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