Webhooks Overview

Lynkwell allows networks to create webhooks for certain events that happen in the Lynkwell system. Webhooks are an excellent way to respond to events in real-time as they happen, enabling you to build integrations that react immediately to changes.

Supported Events

Currently the following event types are supported:

Event TypeDescription
ocpp.messageRaw OCPP messages sent to and from charging stations
asset.connectivityUpdates when a station connects or disconnects from the system

Getting Started

To get started with webhooks:

  1. Create an API client if you don't already have one. If you have an existing API client, it may not have the scopes required to interact with the Webhooks API. If this is the case, please reach out to our support to gain access.
  2. Create a webhook endpoint using the Webhooks API
  3. Store the webhook secret securely - it's only shown once at creation time
  4. Implement signature validation in your endpoint (see Validating Signatures)

Next Steps

Was this page helpful?