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 Type | Description |
|---|---|
ocpp.message | Raw OCPP messages sent to and from charging stations |
asset.connectivity | Updates when a station connects or disconnects from the system |
Getting Started
To get started with webhooks:
- 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.
- Create a webhook endpoint using the Webhooks API
- Store the webhook secret securely - it's only shown once at creation time
- Implement signature validation in your endpoint (see Validating Signatures)
Next Steps
- Events and Deliveries - Understand the webhook data model
- Validating Signatures - Secure your webhook endpoint
- Delivery and Retries - Learn about automatic retries and resending
- Best Practices - Tips for production-ready webhook handlers
