Webhooks

Webhooks make it possible to create a subscription from an external system to events in Lime CRM. You can subscribe to new, update, delete and restore for all available Limetypes, Webhooks system events and any registered custom event

Features

• It is possible to list available events, current subscriptions and register a new or update an existing subscription.
• Subscriptions can be signed with a secret, to validate contents and sender
• Subscriptions can be created via Lime Admin or via API
• Webhooks can be extended with new events by registering custom events

Administration via API

To be able to call the API endpoints, the user must be an Administrator or part of the dedicated Lime CRM group Webhook Users.

IMPORTANT: Users in that group will have the possibility to modify all existing subscriptions.

Administration via Lime Admin

Webhooks can be administrated and created via Lime Admin

Securing webhooks

To secure a webhook subscription you can sign the payload with a secret. When creating a subscription add the optional secret.

All messages delivered in that subscription will have their payload sign with the secret with a HMAC SHA-256. This signature is available in the header X-Lime-Signature as sha256=[signature]. This can be used to verify both contents and sender.

Requirements

• Webhooks is included in a Lime CRM Cloud Solution
• Lime CRM server version 13.2 or newer.
• CRM server MUST NOT use LDC for writes (ie requires use_ldc_for_writes = False in %programdata\LIME Pro Server\Web Server\configs\config.ini). This is the default setting since Lime CRM 13.0
• A Lime CRM Group called Webhook Users