Skip to main content

Stay up to date with webhooks

A webhook is an HTTP notification from MyCRM to an endpoint your integration hosts. It lets you react to relevant changes without continuously polling every resource.

MyCRM supports configured event subscriptions. During onboarding, tell LMG which changes matter to your integration, which records it should cover, the receiving HTTPS URL and the intended environment.

The notification​

{
  "action": "updated",
  "resource": {
    "type": "organisations",
    "id": 1123,
    "url": "https://api.example.com/jsonapi/organisations/1123"
  },
  "webhook": { "name": "Example organisation webhook" }
}

The URL and record above are illustrative. Notifications are sent as application/json; they are not JSON:API response documents. In particular, notification IDs can be numeric while JSON:API resource IDs are strings.

A notification identifies the changed resource. Retrieve current details using your application's normal API credentials where needed and permitted. A notification itself does not grant access to that resource.

Build in three parts​

  1. Understand the event and payload model.
  2. Implement a receiver that durably accepts work.
  3. Design for delivery failures and reconciliation.